Diffusion (diffusion-api 6.11.1 API)

java.lang.Object
- java.lang.Enum<Diffusion>
- - com.pushtechnology.diffusion.client.Diffusion

All Implemented Interfaces:

Serializable, Comparable<Diffusion>
```
public enum Diffusion
extends Enum<Diffusion>
```
Provides facilities that are shared between sessions.

Since:

5.0

Author:

DiffusionData Limited

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Diffusion.Implementation
The contract with the implementation.

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Diffusion.Implementation` The contract with the implementation.

Enum Constant Summary

Enum Constants
Enum Constant and Description

GLOBALS
The implementation.

Enum Constants
Enum Constant and Description
`GLOBALS` The implementation.

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static Credentials.Factory`	`credentials()` Returns shared credentials factory to use for creating credentials.
`static DataTypes`	`dataTypes()` Returns data type implementations.
`static String`	`escape(String string)` Escapes special characters in a string that is to be used within a topic property or a session filter.
`static SessionTrees.BranchMappingTable.Builder`	`newBranchMappingTableBuilder()` Create a new `BranchMappingTable.Builder`.
`static RemoteServers.RemoteServer.Builder`	`newRemoteServerBuilder()` Deprecated. since 6.9 This method may only be used to create an old style builder for secondary initiators. The newer `newRemoteServerBuilder(Class)` specifying the secondary initiator builder class should be used in preference. This method will be removed in a future release.
`static <B extends RemoteServers.RemoteServer.RemoteServerBuilder<B>> B`	`newRemoteServerBuilder(Class<B> builderInterface)` Create a new `RemoteServers.RemoteServer.RemoteServerBuilder`.
`static ClientControl.SessionEventParameters.Builder`	`newSessionEventParametersBuilder()` Create a new `SessionEventParameters.Builder`.
`static Metrics.SessionMetricCollector.Builder`	`newSessionMetricCollectorBuilder()` Create a new `SessionMetricCollector.Builder`.
`static Metrics.TopicMetricCollector.Builder`	`newTopicMetricCollectorBuilder()` Create a new `TopicMetricCollector.Builder`.
`static TopicSpecification`	`newTopicSpecification(TopicType topicType)` Create a new `TopicSpecification` for a given topic type.
`static ProxyAuthenticationFactory`	`proxyAuthentication()` Returns a proxy authentication scheme factory.
`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.
`static SessionId`	`sessionIdFromString(String sessionIdAsString)` Parse a `SessionId` from a string.
`static SessionFactory`	`sessions()` Returns the shared session factory.
`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.
`static TopicSelectors`	`topicSelectors()` Returns a parser for topic selector expressions.
`static UpdateConstraint.Factory`	`updateConstraints()` Returns an update constraint factory.
`static Diffusion`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static Diffusion[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- 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
  - 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
    
    See Also:
    
    UpdateConstraint
  - 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
  - newBranchMappingTableBuilder
```
public static SessionTrees.BranchMappingTable.Builder newBranchMappingTableBuilder()
```
    Create a new BranchMappingTable.Builder.
    
    Since:
    
    6.7
    
    See Also:
    
    SessionTrees
  - newSessionMetricCollectorBuilder
```
public static Metrics.SessionMetricCollector.Builder newSessionMetricCollectorBuilder()
```
    Create a new SessionMetricCollector.Builder.
    
    Since:
    
    6.7
    
    See Also:
    
    Metrics
  - sessionIdFromString
```
public static SessionId sessionIdFromString(String sessionIdAsString)
                                     throws IllegalArgumentException
```
    Parse a SessionId from a string.
    This method allows a SessionId to parsed from a string in the format as generated by SessionId.toString(). This is the representation used in the SESSION_ID session property.
    
    Parameters:
    
    sessionIdAsString - a string, in the format as generated by SessionId.toString()
    
    Returns:
    
    the SessionId
    
    Throws:
    
    IllegalArgumentException - if the string was not compatible with the format as generated by SessionId.toString()
    
    Since:
    
    6.7
  - newTopicMetricCollectorBuilder
```
public static Metrics.TopicMetricCollector.Builder newTopicMetricCollectorBuilder()
```
    Create a new TopicMetricCollector.Builder.
    
    Since:
    
    6.7
    
    See Also:
    
    Metrics
  - newRemoteServerBuilder
```
@Deprecated
public static RemoteServers.RemoteServer.Builder newRemoteServerBuilder()
```
    Deprecated. since 6.9
    This method may only be used to create an old style builder for secondary initiators. The newer newRemoteServerBuilder(Class) specifying the secondary initiator builder class should be used in preference. This method will be removed in a future release.
    
    Create a new RemoteServer.Builder.
    
    Since:
    
    6.7
    
    See Also:
    
    RemoteServers
  - newRemoteServerBuilder
```
public static <B extends RemoteServers.RemoteServer.RemoteServerBuilder<B>> B newRemoteServerBuilder(Class<B> builderInterface)
                                                                                              throws IllegalArgumentException
```
    Create a new RemoteServers.RemoteServer.RemoteServerBuilder.
    
    Type Parameters:
    
    B - builder type
    
    Parameters:
    
    builderInterface - the builder interface
    
    Returns:
    
    the builder
    
    Throws:
    
    IllegalArgumentException - if builderInterface is not a supported builder interface
    
    Since:
    
    6.9
    
    See Also:
    
    RemoteServers
  - newSessionEventParametersBuilder
```
public static ClientControl.SessionEventParameters.Builder newSessionEventParametersBuilder()
```
    Create a new SessionEventParameters.Builder.
    
    Returns:
    
    the builder
    
    Since:
    
    6.11

Enum Diffusion

Nested Class Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

GLOBALS

Method Detail

values

valueOf

sessions

credentials

topicSelectors

proxyAuthentication

dataTypes

escape

newTopicSpecification

updateConstraints

stringToRoles

rolesToString

newBranchMappingTableBuilder

newSessionMetricCollectorBuilder

sessionIdFromString

newTopicMetricCollectorBuilder

newRemoteServerBuilder

newRemoteServerBuilder

newSessionEventParametersBuilder