|
Configuration Platform SDK 7.6 API Reference | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.genesyslab.platform.commons.protocol.AbstractChannel
com.genesyslab.platform.commons.protocol.DuplexChannel
com.genesyslab.platform.commons.protocol.ClientChannel
com.genesyslab.platform.configuration.protocol.ConfServerProtocol
Field Summary |
Fields inherited from interface com.genesyslab.platform.commons.protocol.Channel |
DEFAULT_TIMEOUT, INFINITE_TIMEOUT |
Fields inherited from interface com.genesyslab.platform.commons.protocol.Receiver |
DEF_INPUT_SIZE |
Constructor Summary | |
ConfServerProtocol(Endpoint endpoint)
|
|
ConfServerProtocol(Endpoint endpoint,
boolean initCrypto)
|
|
ConfServerProtocol(Endpoint endpoint,
long timeout,
boolean initCrypto)
Please note that initializing cryptoengine can take some time, so if you are absolutly sure your server doesn't (and won't) support AES encripting set the initCrypt parameter to false. |
Method Summary | |
int |
getClientApplicationType()
|
java.lang.String |
getClientName()
|
ConfServerClientType |
getClientType()
Deprecated. |
java.lang.String |
getProtocolVersion()
Deprecated. |
void |
getSchema(javax.xml.transform.Result result)
Deprecated. |
ConfServerContext |
getServerContext()
ConfServerContext property gets protocol context of Configuration Server ConfServerProtocol opened connection with. |
java.lang.String |
getServerVersion()
Deprecated. |
boolean |
getUseDeltaOptimization()
UseDeltaOptimization property sets/gets the delta cleanup processing. |
boolean |
getUseForwardCompatibility()
Forward compatibility feature enabling option value getting method. |
java.lang.String |
getUserName()
|
java.lang.String |
getUserPassword()
|
boolean |
getUseSession()
Get session usage. |
static void |
initCrypto()
Usually initializing of cryptoengine takes a lot of time and can cause timeouts if will be performed during open procedure. |
boolean |
isSessionRestored()
Deprecated. |
void |
setClientApplicationType(int clientType)
|
void |
setClientName(java.lang.String clientName)
|
void |
setClientType(ConfServerClientType clientType)
Deprecated. |
void |
setTKVPrinter(com.genesyslab.platform.commons.collections.processor.KeyValuePrinter printer)
|
void |
setUseDeltaOptimization(boolean value)
UseDeltaOptimization property sets/gets the delta cleanup processing. |
void |
setUseForwardCompatibility(boolean value)
Forward compatibility feature enabling option value setting method. |
void |
setUserName(java.lang.String userName)
|
void |
setUserPassword(java.lang.String userPasssword)
|
void |
setUseSession(boolean useSession)
Set session usage. |
Methods inherited from class com.genesyslab.platform.commons.protocol.ClientChannel |
beginRequest, endRequest, endRequest, getCopyResponse, getReferenceBuilder, request, request, setCopyResponse |
Methods inherited from class com.genesyslab.platform.commons.protocol.DuplexChannel |
beginClose, beginOpen, clearInput, close, close, getInputSize, getInterceptor, getProtocolDescription, open, open, receive, receive, releaseReceivers, resetReceiver, send, setConnectionInvoker, setInputSize, setReceiver, toString |
Methods inherited from class com.genesyslab.platform.commons.protocol.AbstractChannel |
addChannelListener, configure, getConfiguration, getEndpoint, getState, getTimeout, removeChannelListener, setEndpoint, setInvoker, setTimeout |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface com.genesyslab.platform.commons.protocol.Channel |
close, close, getTimeout, open, open, setTimeout |
Methods inherited from interface com.genesyslab.platform.commons.protocol.AsyncChannel |
beginClose, beginOpen, getState |
Methods inherited from interface com.genesyslab.platform.commons.protocol.ChannelListenerSupport |
addChannelListener, removeChannelListener |
Methods inherited from interface com.genesyslab.platform.commons.protocol.MessageReceiver |
receive, receive |
Methods inherited from interface com.genesyslab.platform.commons.protocol.Receiver |
clearInput, getInputSize, releaseReceivers, setInputSize |
Methods inherited from interface com.genesyslab.platform.commons.protocol.OutputChannel |
send |
Methods inherited from interface com.genesyslab.platform.commons.protocol.InterceptorSupport |
getInterceptor |
Methods inherited from interface com.genesyslab.platform.commons.protocol.MessageReceiverManagement |
setReceiver |
Methods inherited from interface com.genesyslab.platform.commons.protocol.ReceiverManagement |
resetReceiver |
Methods inherited from interface com.genesyslab.platform.commons.protocol.ConfigurationSupport |
configure, getConfiguration |
Methods inherited from interface com.genesyslab.platform.commons.protocol.EndpointSupport |
getEndpoint, setEndpoint |
Methods inherited from interface com.genesyslab.platform.commons.protocol.ProtocolDescriptionSupport |
getProtocolDescription |
Methods inherited from interface com.genesyslab.platform.commons.protocol.AsyncInvokerSupport |
setInvoker |
Methods inherited from interface com.genesyslab.platform.commons.protocol.ConnectionInvokerSupport |
setConnectionInvoker |
Constructor Detail |
public ConfServerProtocol(Endpoint endpoint)
public ConfServerProtocol(Endpoint endpoint, boolean initCrypto)
public ConfServerProtocol(Endpoint endpoint, long timeout, boolean initCrypto)
initCrypt
parameter to false.
Alternatively you can increase the timeout needed for open and let
registration procedure to initialize cryptographic engine on-demand.
endpoint
- server to connect totimeout
- timeout for protocol operationsinitCrypto
- whether to initialize cryptoengine during constructionMethod Detail |
public ConfServerContext getServerContext()
public static void initCrypto()
public ConfServerClientType getClientType()
getClientApplicationType()
public void setClientType(ConfServerClientType clientType)
clientType
- client typesetClientApplicationType(int)
public int getClientApplicationType()
public void setClientApplicationType(int clientType)
public java.lang.String getClientName()
public void setClientName(java.lang.String clientName)
public java.lang.String getUserName()
public void setUserName(java.lang.String userName)
public java.lang.String getUserPassword()
public void setUserPassword(java.lang.String userPasssword)
public java.lang.String getProtocolVersion()
getServerContext()
,
ConfServerContext.getProtocolVersion()
public boolean getUseForwardCompatibility()
setUseForwardCompatibility(boolean)
public void setUseForwardCompatibility(boolean value)
value
- forward compatibility algorithm allowing flagpublic boolean getUseDeltaOptimization()
public void setUseDeltaOptimization(boolean value)
value
- new value for delta optimization usage propetypublic boolean getUseSession()
Session Usage.
1. Enforce session usage.
2. Open protocol.
3. Check if session is restored. If it is not, register for notifications.
Notification registration is needed only if the protocol opened without session restored, otherwise notification state is restored on the server side.
Please note, that if session is restored the protocol will issue RequestHistoryLog to server. RequestHistoryLog provides all changes that happend after the last time the protocol was closed. Upon receiving the request server sends all changes (event per change) that happended to any object the protocol was registered to receive notifications on whethere explicitely (by registering on notifications) or via restoring session. So, be prepared to receive some updates if you use session restoration.
getServerContext()
,
ConfServerContext.isSessionRestored()
public void setUseSession(boolean useSession)
useSession
- whether session is usedgetUseSession()
public boolean isSessionRestored()
getServerContext()
,
ConfServerContext.isSessionRestored()
,
getUseSession()
public void setTKVPrinter(com.genesyslab.platform.commons.collections.processor.KeyValuePrinter printer)
public java.lang.String getServerVersion()
getProtocolVersion()
.
getServerContext()
,
ConfServerContext.getServerVersion()
public void getSchema(javax.xml.transform.Result result) throws javax.xml.transform.TransformerException
result
- transformation result document to generate schema into
javax.xml.transform.TransformerException
- document generation errorgetServerContext()
,
ConfServerContext.getSchema(javax.xml.transform.Result)
|
Configuration Platform SDK 7.6 API Reference | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |