|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.genesyslab.platform.applicationblocks.com.ConfServiceFactory
public final class ConfServiceFactory
This class is used to create an instance of the Configuration Service.
An instance of the cfgService must be created before any Configuration
Server requests can be made. For example:
Note: ConfService may be created on closed protocol instance only.
Also, to dispose (to 'release') such ConfService instance,
it is recommended to close the protocol before it.
// Initialize ConfService:
PropertyConfiguration config;
ConfServerProtocol protocol;
IConfService cfgService;
config = new PropertyConfiguration();
config.setUseAddp(true);
config.setAddpClientTimeout(15);
protocol = new ConfServerProtocol(new Endpoint("ConfigServer", csHost, csPort, config));
protocol.setUserName(userName);
protocol.setUserPassword(password);
protocol.setClientName(clientName);
protocol.setClientApplicationType(clientType.ordinal());
cfgService = ConfServiceFactory.createConfService(protocol);
protocol.open();
...
// Deinitialize ConfService:
protocol.close();
ConfServiceFactory.releaseConfService(cfgService);
cfgService = null;
Method Summary | |
---|---|
static IConfService |
createConfService(Protocol protocol)
This method creates an instance of a Configuration Service based on the specified protocol. |
static IConfService |
createConfService(Protocol protocol,
boolean enableCaching)
This method creates an instance of a Configuration Service based on the specified protocol. |
static IConfService |
createConfService(Protocol protocol,
IConfServicePolicy confServicePolicy,
IConfCache cache)
Creates a configuration service with the specified policy information. |
static IConfService |
createConfService(Protocol protocol,
IConfServicePolicy confServicePolicy,
IConfCachePolicy confCachePolicy)
Creates a configuration service with the specified policy information. |
static void |
releaseConfService(IConfService confService)
Removes the specified configuration service from the internal list and unregisters it using the subscription service with which it had been registered. |
static IConfService |
retrieveConfService(Endpoint endpoint)
Deprecated. |
static IConfService |
retrieveConfService(Protocol protocol)
Retrieves an instance of the Configuration Service based on the specified protocol. |
static void |
setConfServiceCreator(ConfServiceCreator creator)
This method is intended for usage in exclusive cases by advanced users with deep understanding of COM AB architecture. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public static void setConfServiceCreator(ConfServiceCreator creator)
public static IConfService createConfService(Protocol protocol)
protocol
- A configuration cfgService protocol
public static IConfService createConfService(Protocol protocol, boolean enableCaching)
protocol
- The configuration service protocolenableCaching
- If set to true caching functionality will be turned on
public static IConfService createConfService(Protocol protocol, IConfServicePolicy confServicePolicy, IConfCachePolicy confCachePolicy)
protocol
- Configuration Server protocolconfServicePolicy
- The policy for the created configuration serviceconfCachePolicy
- The policy for the cache
public static IConfService createConfService(Protocol protocol, IConfServicePolicy confServicePolicy, IConfCache cache)
protocol
- Configuration Server protocolconfServicePolicy
- The policy for the servicecache
- An object implementing the IConfCache interface
public static IConfService retrieveConfService(Protocol protocol)
protocol
- An instance of configuration protocol associated with a previously created
configuration service
@Deprecated public static IConfService retrieveConfService(Endpoint endpoint)
endpoint
- An endpoint identifier.
null
if it was not found.public static void releaseConfService(IConfService confService)
confService
- the configuration service to release.
java.lang.IllegalArgumentException
- if given ConfService value is not valid.
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |