Enum Constant Detail

• GLOBALS

  public static final Diffusion GLOBALS

  The implementation.

Method Detail

• values

  public static Diffusion[] values()

  Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

  for (Diffusion c : Diffusion.values())
      System.out.println(c);
  

  Returns:

  an array containing the constants of this enum type, in the order they are declared

• valueOf

  public static Diffusion valueOf(String name)

  Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

  Parameters:

  name - the name of the enum constant to be returned.

  Returns:

  the enum constant with the specified name

  Throws:

  IllegalArgumentException - if this enum type has no constant with the specified name

  NullPointerException - if the argument is null

• sessions

  public static SessionFactory sessions()

  Returns the shared session factory.

  Returns:

  session factory.

• credentials

  public static Credentials.Factory credentials()

  Returns shared credentials factory to use for creating credentials.

  Returns:

  credentials factory.

• topicSelectors

  public static TopicSelectors topicSelectors()

  Returns a parser for topic selector expressions.

  Returns:

  topic selectors parser

• proxyAuthentication

  public static ProxyAuthenticationFactory proxyAuthentication()

  Returns a proxy authentication scheme factory.

  Returns:

  proxy authentication scheme factory

• authenticationResult

  @Deprecated
  public static AuthenticationResultSource authenticationResult()

  Deprecated. since 6.2

  AuthenticationHandler is being replaced by the Authenticator interface. New authentication handlers should implement Authenticator. This method will be removed in a future release.

  Returns an empty AuthenticationResultSource that can be used by authentication handlers as a starting point to create AuthenticationResults.

  AuthenticationResultSource provides a fluent API for creating authentication results. For example:

   // All returned results are derived from this one.
   AuthenticationResultSource defaultResult =
       Diffusion.authenticationResult().withRoles("USER");
  
   // ...
   // The authentication handler grants the new session both the
   // ADMINISTRATOR and USER roles.
   AuthenticationResult result = defaultResult.withRoles("ADMINISTATOR");
   authenticationHandlerCallback.allow(result);
   

  Returns:

  a base authentication result

  Since:

  5.2

• dataTypes

  public static DataTypes dataTypes()

  Returns data type implementations.

  Since:

  5.7

• escape

  public static String escape(String string)

  Escapes special characters in a string that is to be used within a topic property or a session filter.

  This is a convenience method which inserts an escape character '\' before any of the special characters ' " or \.

  Parameters:

  string - the string to be escaped

  Returns:

  the string value with escape characters inserted as appropriate

  Since:

  6.1

• newTopicSpecification

  public static TopicSpecification newTopicSpecification(TopicType topicType)

  Create a new TopicSpecification for a given topic type.

  Parameters:

  topicType - the topic type

  Returns:

  a new immutable specification with no properties set. New specifications with different properties can be produced using the withProperty or withProperties methods of the provided specification.

  Since:

  6.2

• updateConstraints

  public static UpdateConstraint.Factory updateConstraints()

  Returns an update constraint factory.

  Returns:

  update constraint factory

  Since:

  6.2

• stringToRoles

  public static Set<String> stringToRoles(String string)

  Utility method which converts a string of the format required by the $Roles session property into a mutable set of strings.

  Parameters:

  string - the string with quoted roles separated by whitespace or commas

  Returns:

  set of roles

  Since:

  6.2

• rolesToString

  public static String rolesToString(Set<String> roles)

  Utility method which converts a set of authorisation roles to the string format required by the $Roles session property.

  Parameters:

  roles - a set of roles

  Returns:

  a string representing the supplied roles, formatted as required by the $Roles session property

  Since:

  6.2