CoherenceModule (Oracle® Fusion Middleware Java API Reference for the Lifecycle Management Environment Specification)

java.lang.Object
- oracle.fmwplatform.envspec.model.blueprint.coherence.CoherenceModule

```
public class CoherenceModule
extends Object
```
A CoherenceModule is group of Coherence-related settings for a Coherence cluster

Since:

12.2.2.0

Constructor Summary

Constructors
Constructor and Description

CoherenceModule()

Constructors
Constructor and Description
`CoherenceModule()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`addAddressProvider(CoherenceAddressProvider addressProvider)` Add an address provider.
`boolean`	`addCache(CoherenceCache cache)` Add a cache.
`boolean`	`addService(CoherenceService service)` Add a service.
`boolean`	`addWellKnownAddress(CoherenceClusterWellKnownAddress wka)` Add a well-known address.
`CoherenceAddressProvider`	`getAddressProvider(String id)` Get the specified address provider.
`List<CoherenceAddressProvider>`	`getAddressProviders()` Get the list of address providers.
`CoherenceCache`	`getCache(String name)` Get the specified cache.
`List<CoherenceCache>`	`getCaches()` Get the list of caches.
`Long`	`getCustomClusterConfigurationFileLastUpdatedTimestamp()` Get the last updated timestamp for the custom config file.
`String`	`getCustomClusterConfigurationFileName()` Get the custom config file name.
`PersistenceMode`	`getDefaultPersistenceMode()` Get the default persistence mode.
`FederationTopology`	`getFederationTopology()` Get the federation topology.
`String`	`getId()` Get the ID.
`CoherenceIdentityAsserter`	`getIdentityAsserter()` Get the identity asserter.
`String`	`getLoggerName()` Get the logger name.
`Boolean`	`getLoggingEnabled()` Get whether or not logging is enabled.
`String`	`getLogMessageFormat()` Get the log message format.
`String`	`getName()` Get the name.
`String`	`getPersistenceActiveDirectory()` Get the active persistence directory.
`String`	`getPersistenceSnapshotDirectory()` Get the snapshot persistence directory.
`String`	`getPersistenceTrashDirectory()` Get the trash persistence directory.
`String`	`getRemoteCoherenceClusterName()` Get the remote cluster name.
`Boolean`	`getSecurityFrameworkEnabled()` Get whether or not the security framework is enabled.
`CoherenceService`	`getService(String name)` Get the specified service.
`List<CoherenceService>`	`getServices()` Get the list of services.
`Integer`	`getTimeToLive()` Get the time-to-live.
`TransportType`	`getTransportType()` Get the transport type.
`Boolean`	`getUnicastPortAutoAdjust()` Get whether or not to automatically adjust the unicast port.
`String`	`getVersion()` Get the version.
`CoherenceClusterWellKnownAddress`	`getWellKnownAddress(String id)` Get the specified well-known address.
`List<CoherenceClusterWellKnownAddress>`	`getWellKnownAddresses()` Get the list of well-known addresses.
`boolean`	`isCoherenceClusterParamsEmpty()` Determine whether or not the ClusterParams folder-related params are empty.
`boolean`	`isCoherenceFederationParamsEmpty()` Determines whether or not the FederationParams folder-related params are empty.
`boolean`	`isCoherenceLoggingParamsEmpty()` Determines whether or not the LoggingParams folder-related params are empty.
`boolean`	`isPersistenceParamsEmpty()` Determines whether or not the PersistenceParams folder-related params are empty.
`CoherenceModule`	`setCustomClusterConfigurationFileLastUpdatedTimestamp(Long customClusterConfigurationFileLastUpdatedTimestamp)` Set the last updated timestamp for the custom config file.
`CoherenceModule`	`setCustomClusterConfigurationFileName(String customClusterConfigurationFileName)` Set the custom config file name.
`CoherenceModule`	`setDefaultPersistenceMode(PersistenceMode defaultPersistenceMode)` Set the default persistence mode.
`CoherenceModule`	`setFederationTopology(FederationTopology federationTopology)` Set the federation topology.
`CoherenceModule`	`setId(String id)` Set the ID.
`CoherenceModule`	`setIdentityAsserter(CoherenceIdentityAsserter identityAsserter)` Set the identity asserter.
`CoherenceModule`	`setLoggerName(String loggerName)` Set the logger name.
`CoherenceModule`	`setLoggingEnabled(Boolean loggingEnabled)` Set whether or not logging is enabled.
`CoherenceModule`	`setLogMessageFormat(String logMessageFormat)` Set the log message format.
`CoherenceModule`	`setName(String name)` Set the name.
`CoherenceModule`	`setPersistenceActiveDirectory(String persistenceActiveDirectory)` Set the active persistence directory.
`CoherenceModule`	`setPersistenceSnapshotDirectory(String persistenceSnapshotDirectory)` Set the snapshot persistence directory.
`CoherenceModule`	`setPersistenceTrashDirectory(String persistenceTrashDirectory)` Set the trash persistence directory.
`CoherenceModule`	`setRemoteCoherenceClusterName(String remoteCoherenceClusterName)` Set the remote cluster name.
`CoherenceModule`	`setSecurityFrameworkEnabled(Boolean securityFrameworkEnabled)` Set whether or not the security framework is enabled.
`CoherenceModule`	`setTimeToLive(Integer timeToLive)` Set the time-to-live
`CoherenceModule`	`setTransportType(TransportType transportType)` Set the transport type.
`CoherenceModule`	`setUnicastPortAutoAdjust(Boolean unicastPortAutoAdjust)` Set whether or not to automatically adjust the unicast port.
`CoherenceModule`	`setVersion(String version)` Set the version.
`String`	`toCompactString()` Returns a compact string representation of the object in XML format.
`String`	`toJsonCompactString()` Returns a compact string representation of the object in JSON format.
`String`	`toJsonString()` Returns a string representation of the object in JSON format.
`String`	`toString()` Returns a string representation of the object in XML format.
`String`	`toXmlCompactString()` Returns a compact string representation of the object in XML format.
`String`	`toXmlString()` Returns a string representation of the object in XML format.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CoherenceModule
```
public CoherenceModule()
```
- Method Detail
  - getId
```
public String getId()
```
    Get the ID.
    
    Returns:
    
    the ID
  - setId
```
public CoherenceModule setId(String id)
```
    Set the ID.
    
    Parameters:
    
    id - the new ID
    
    Returns:
    
    the current CoherenceModule object
  - getCustomClusterConfigurationFileLastUpdatedTimestamp
```
public Long getCustomClusterConfigurationFileLastUpdatedTimestamp()
```
    Get the last updated timestamp for the custom config file.
    
    Returns:
    
    the last updated timestamp
  - setCustomClusterConfigurationFileLastUpdatedTimestamp
```
public CoherenceModule setCustomClusterConfigurationFileLastUpdatedTimestamp(Long customClusterConfigurationFileLastUpdatedTimestamp)
```
    Set the last updated timestamp for the custom config file.
    
    Parameters:
    
    customClusterConfigurationFileLastUpdatedTimestamp - the new last updated time
    
    Returns:
    
    the current CoherenceModule object
  - getCustomClusterConfigurationFileName
```
public String getCustomClusterConfigurationFileName()
```
    Get the custom config file name.
    
    Returns:
    
    the file name
  - setCustomClusterConfigurationFileName
```
public CoherenceModule setCustomClusterConfigurationFileName(String customClusterConfigurationFileName)
```
    Set the custom config file name.
    
    Parameters:
    
    customClusterConfigurationFileName - thbe new file name
    
    Returns:
    
    the current CoherenceModule object
  - getName
```
public String getName()
```
    Get the name.
    
    Returns:
    
    the name
  - setName
```
public CoherenceModule setName(String name)
```
    Set the name.
    
    Parameters:
    
    name - the new name
    
    Returns:
    
    the current CoherenceModule object
  - getVersion
```
public String getVersion()
```
    Get the version.
    
    Returns:
    
    the version
  - setVersion
```
public CoherenceModule setVersion(String version)
```
    Set the version.
    
    Parameters:
    
    version - the new version
    
    Returns:
    
    the current CoherenceModule object
  - getSecurityFrameworkEnabled
```
public Boolean getSecurityFrameworkEnabled()
```
    Get whether or not the security framework is enabled.
    
    Returns:
    
    whether or not the security framework is enabled
  - setSecurityFrameworkEnabled
```
public CoherenceModule setSecurityFrameworkEnabled(Boolean securityFrameworkEnabled)
```
    Set whether or not the security framework is enabled.
    
    Parameters:
    
    securityFrameworkEnabled - the new value
    
    Returns:
    
    the current CoherenceModule object
  - getTimeToLive
```
public Integer getTimeToLive()
```
    Get the time-to-live.
    
    Returns:
    
    the time-to-live
  - setTimeToLive
```
public CoherenceModule setTimeToLive(Integer timeToLive)
```
    Set the time-to-live
    
    Parameters:
    
    timeToLive - the new time-to-live
    
    Returns:
    
    the current CoherenceModule object
  - getTransportType
```
public TransportType getTransportType()
```
    Get the transport type.
    
    Returns:
    
    the transport type
  - setTransportType
```
public CoherenceModule setTransportType(TransportType transportType)
```
    Set the transport type.
    
    Parameters:
    
    transportType - the new transport type
    
    Returns:
    
    the current CoherenceModule object
  - getUnicastPortAutoAdjust
```
public Boolean getUnicastPortAutoAdjust()
```
    Get whether or not to automatically adjust the unicast port.
    
    Returns:
    
    whether or not to automatically adjust the unicast port
  - setUnicastPortAutoAdjust
```
public CoherenceModule setUnicastPortAutoAdjust(Boolean unicastPortAutoAdjust)
```
    Set whether or not to automatically adjust the unicast port.
    
    Parameters:
    
    unicastPortAutoAdjust - the new value
    
    Returns:
    
    the current CoherenceModule object
  - getFederationTopology
```
public FederationTopology getFederationTopology()
```
    Get the federation topology.
    
    Returns:
    
    the federation topology
  - setFederationTopology
```
public CoherenceModule setFederationTopology(FederationTopology federationTopology)
```
    Set the federation topology.
    
    Parameters:
    
    federationTopology - the new federation topology
    
    Returns:
    
    the current CoherenceModule object
  - getRemoteCoherenceClusterName
```
public String getRemoteCoherenceClusterName()
```
    Get the remote cluster name.
    
    Returns:
    
    the remote cluster name
  - setRemoteCoherenceClusterName
```
public CoherenceModule setRemoteCoherenceClusterName(String remoteCoherenceClusterName)
```
    Set the remote cluster name.
    
    Parameters:
    
    remoteCoherenceClusterName - the new remote cluster name
    
    Returns:
    
    the current CoherenceModule object
  - getLoggingEnabled
```
public Boolean getLoggingEnabled()
```
    Get whether or not logging is enabled.
    
    Returns:
    
    whether or not logging is enabled
  - setLoggingEnabled
```
public CoherenceModule setLoggingEnabled(Boolean loggingEnabled)
```
    Set whether or not logging is enabled.
    
    Parameters:
    
    loggingEnabled - the new value
    
    Returns:
    
    the current CoherenceModule object
  - getLoggerName
```
public String getLoggerName()
```
    Get the logger name.
    
    Returns:
    
    the logger name
  - setLoggerName
```
public CoherenceModule setLoggerName(String loggerName)
```
    Set the logger name.
    
    Parameters:
    
    loggerName - the new logger name
    
    Returns:
    
    the current CoherenceModule object
  - getLogMessageFormat
```
public String getLogMessageFormat()
```
    Get the log message format.
    
    Returns:
    
    the log message format
  - setLogMessageFormat
```
public CoherenceModule setLogMessageFormat(String logMessageFormat)
```
    Set the log message format.
    
    Parameters:
    
    logMessageFormat - the new log message format
    
    Returns:
    
    the current CoherenceModule object
  - getPersistenceActiveDirectory
```
public String getPersistenceActiveDirectory()
```
    Get the active persistence directory.
    
    Returns:
    
    the active persistence directory
  - setPersistenceActiveDirectory
```
public CoherenceModule setPersistenceActiveDirectory(String persistenceActiveDirectory)
```
    Set the active persistence directory.
    
    Parameters:
    
    persistenceActiveDirectory - the new active persistence directory
    
    Returns:
    
    the current CoherenceModule object
  - getDefaultPersistenceMode
```
public PersistenceMode getDefaultPersistenceMode()
```
    Get the default persistence mode.
    
    Returns:
    
    the default persistence mode
  - setDefaultPersistenceMode
```
public CoherenceModule setDefaultPersistenceMode(PersistenceMode defaultPersistenceMode)
```
    Set the default persistence mode.
    
    Parameters:
    
    defaultPersistenceMode - the new default persistence mode
    
    Returns:
    
    the current CoherenceModule object
  - getPersistenceSnapshotDirectory
```
public String getPersistenceSnapshotDirectory()
```
    Get the snapshot persistence directory.
    
    Returns:
    
    the snapshot persistence directory
  - setPersistenceSnapshotDirectory
```
public CoherenceModule setPersistenceSnapshotDirectory(String persistenceSnapshotDirectory)
```
    Set the snapshot persistence directory.
    
    Parameters:
    
    persistenceSnapshotDirectory - the new snapshot persistence directory
    
    Returns:
    
    the current CoherenceModule object
  - getPersistenceTrashDirectory
```
public String getPersistenceTrashDirectory()
```
    Get the trash persistence directory.
    
    Returns:
    
    the trash persistence directory
  - setPersistenceTrashDirectory
```
public CoherenceModule setPersistenceTrashDirectory(String persistenceTrashDirectory)
```
    Set the trash persistence directory.
    
    Parameters:
    
    persistenceTrashDirectory - the new trash persistence directory
    
    Returns:
    
    the current CoherenceModule object
  - addAddressProvider
```
public boolean addAddressProvider(CoherenceAddressProvider addressProvider)
```
    Add an address provider.
    
    Parameters:
    
    addressProvider - the address provider to add
    
    Returns:
    
    whether or not the address provider was added
  - getAddressProvider
```
public CoherenceAddressProvider getAddressProvider(String id)
```
    Get the specified address provider.
    
    Parameters:
    
    id - the ID of the address provider to get
    
    Returns:
    
    the specified address provider or null, if it was not found
  - getAddressProviders
```
public List<CoherenceAddressProvider> getAddressProviders()
```
    Get the list of address providers.
    
    Returns:
    
    the list of address providers
  - getIdentityAsserter
```
public CoherenceIdentityAsserter getIdentityAsserter()
```
    Get the identity asserter.
    
    Returns:
    
    the identity asserter
  - setIdentityAsserter
```
public CoherenceModule setIdentityAsserter(CoherenceIdentityAsserter identityAsserter)
```
    Set the identity asserter.
    
    Parameters:
    
    identityAsserter - the new identity asserter
    
    Returns:
    
    the current CoherenceModule object
  - addCache
```
public boolean addCache(CoherenceCache cache)
```
    Add a cache.
    
    Parameters:
    
    cache - the cache to add
    
    Returns:
    
    whether or not the cache was added
  - getCache
```
public CoherenceCache getCache(String name)
```
    Get the specified cache.
    
    Parameters:
    
    name - the name of the cache to get
    
    Returns:
    
    the cache or null, if it was not found
  - getCaches
```
public List<CoherenceCache> getCaches()
```
    Get the list of caches.
    
    Returns:
    
    trhe list of caches
  - addWellKnownAddress
```
public boolean addWellKnownAddress(CoherenceClusterWellKnownAddress wka)
```
    Add a well-known address.
    
    Parameters:
    
    wka - the well-known address to add
    
    Returns:
    
    whether or not the well-known address was added
  - getWellKnownAddress
```
public CoherenceClusterWellKnownAddress getWellKnownAddress(String id)
```
    Get the specified well-known address.
    
    Parameters:
    
    id - the id of the well-known address to get
    
    Returns:
    
    the specified well-known address or null, if it was not found
  - getWellKnownAddresses
```
public List<CoherenceClusterWellKnownAddress> getWellKnownAddresses()
```
    Get the list of well-known addresses.
    
    Returns:
    
    the list of well-known addresses
  - addService
```
public boolean addService(CoherenceService service)
```
    Add a service.
    
    Parameters:
    
    service - the service to add
    
    Returns:
    
    whether or not the service was added
  - getService
```
public CoherenceService getService(String name)
```
    Get the specified service.
    
    Parameters:
    
    name - the name of the service to get
    
    Returns:
    
    the specified service or null, if it was not found
  - getServices
```
public List<CoherenceService> getServices()
```
    Get the list of services.
    
    Returns:
    
    the list of services
  - isCoherenceClusterParamsEmpty
```
public boolean isCoherenceClusterParamsEmpty()
```
    Determine whether or not the ClusterParams folder-related params are empty.
    
    Returns:
    
    whether or not the ClusterParams folder-related params are empty
  - isCoherenceFederationParamsEmpty
```
public boolean isCoherenceFederationParamsEmpty()
```
    Determines whether or not the FederationParams folder-related params are empty.
    
    Returns:
    
    whether or not the FederationParams folder-related params are empty
  - isCoherenceLoggingParamsEmpty
```
public boolean isCoherenceLoggingParamsEmpty()
```
    Determines whether or not the LoggingParams folder-related params are empty.
    
    Returns:
    
    whether or not the LoggingParams folder-related params are empty
  - isPersistenceParamsEmpty
```
public boolean isPersistenceParamsEmpty()
```
    Determines whether or not the PersistenceParams folder-related params are empty.
    
    Returns:
    
    whether or not the PersistenceParams folder-related params are empty
  - toXmlCompactString
```
public String toXmlCompactString()
```
    Returns a compact string representation of the object in XML format.
    
    Returns:
    
    a compact string representation of the object in XML format
  - toXmlString
```
public String toXmlString()
```
    Returns a string representation of the object in XML format.
    
    Returns:
    
    a string representation of the object in XML format
  - toJsonCompactString
```
public String toJsonCompactString()
```
    Returns a compact string representation of the object in JSON format.
    
    Returns:
    
    a compact string representation of the object in JSON format
  - toJsonString
```
public String toJsonString()
```
    Returns a string representation of the object in JSON format.
    
    Returns:
    
    a string representation of the object in JSON format
  - toCompactString
```
public String toCompactString()
```
    Returns a compact string representation of the object in XML format.
    
    Returns:
    
    a compact string representation of the object in XML format
  - toString
```
public String toString()
```
    Returns a string representation of the object in XML format.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a string representation of the object in XML format

Class CoherenceModule

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CoherenceModule

Method Detail

getId

setId

getCustomClusterConfigurationFileLastUpdatedTimestamp

setCustomClusterConfigurationFileLastUpdatedTimestamp

getCustomClusterConfigurationFileName

setCustomClusterConfigurationFileName

getName

setName

getVersion

setVersion

getSecurityFrameworkEnabled

setSecurityFrameworkEnabled

getTimeToLive

setTimeToLive

getTransportType

setTransportType

getUnicastPortAutoAdjust

setUnicastPortAutoAdjust

getFederationTopology

setFederationTopology

getRemoteCoherenceClusterName

setRemoteCoherenceClusterName

getLoggingEnabled

setLoggingEnabled

getLoggerName

setLoggerName

getLogMessageFormat

setLogMessageFormat

getPersistenceActiveDirectory

setPersistenceActiveDirectory

getDefaultPersistenceMode

setDefaultPersistenceMode

getPersistenceSnapshotDirectory

setPersistenceSnapshotDirectory

getPersistenceTrashDirectory

setPersistenceTrashDirectory

addAddressProvider

getAddressProvider

getAddressProviders

getIdentityAsserter

setIdentityAsserter

addCache

getCache

getCaches

addWellKnownAddress

getWellKnownAddress

getWellKnownAddresses

addService

getService

getServices

isCoherenceClusterParamsEmpty

isCoherenceFederationParamsEmpty

isCoherenceLoggingParamsEmpty

isPersistenceParamsEmpty

toXmlCompactString

toXmlString

toJsonCompactString

toJsonString

toCompactString

toString