|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.openmuc.openiec61850.ClientSap
public final class ClientSap
The ClientSap
class represents the IEC 61850 service access point for client applications. A client
application that wants to connect to a server should first create an instance of ClientSap
. Next all the
necessary configuration parameters can be set. Finally the associate
function is called to connect to
the server. An instance of ClientSap
can be used to create an unlimited number of associations. Changing
the parameters of a ClientSap has no affect on associations that have already been created.
Constructor Summary | |
---|---|
ClientSap()
Use this constructor to create a default client SAP. |
|
ClientSap(javax.net.SocketFactory socketFactory)
Use this constructor to create a client SAP that uses the given SocketFactory to connect to servers. |
Method Summary | |
---|---|
ClientAssociation |
associate(java.net.InetAddress address,
int port,
java.lang.String authenticationParameter)
Connects to the IEC 61850 MMS server at the given address and port and returns the resulting association object. |
ClientAssociation |
associate(java.net.InetAddress address,
int port,
java.lang.String authenticationParameter,
java.net.InetAddress localAddr,
int localPort)
Connects to the IEC 61850 MMS server at the given address and port and returns the resulting association object. |
int |
getMaxMmsPduSize()
Gets the maximum MMS PDU size. |
byte[] |
getServicesSupportedCalling()
Gets the ServicesSupportedCalling parameter. |
void |
setMaxMmsPduSize(int size)
Sets the maximum MMS PDU size in bytes that the client association will support. |
void |
setMessageFragmentTimeout(int timeout)
Sets the message fragment timeout. |
void |
setResponseTimeout(int timeout)
Sets the default response timeout of the ClientAssociation that is created using this ClientSap. |
void |
setServicesSupportedCalling(byte[] services)
Sets the SevicesSupportedCalling parameter. |
void |
setTSelLocal(byte[] tSelLocal)
Sets the local/calling Transport-Selector (T-SEL). |
void |
setTSelRemote(byte[] tSelRemote)
Sets the remote/called Transport-Selector (T-SEL). |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ClientSap()
public ClientSap(javax.net.SocketFactory socketFactory)
SocketFactory
to connect to servers.
You could pass an SSLSocketFactory to enable SSL.
Method Detail |
---|
public void setMaxMmsPduSize(int size)
size
- cannot be less than 64. The upper limit is 65000 so that segmentation at the lower transport layer is
avoided. The Transport Layer's maximum PDU size is 65531.public int getMaxMmsPduSize()
public void setServicesSupportedCalling(byte[] services)
services
- the ServicesSupportedCalling parameterpublic byte[] getServicesSupportedCalling()
public void setTSelRemote(byte[] tSelRemote)
tSelRemote
- the remote/called T-SEL. If null the T-SEL will be omitted. No maximum size is defined by the
standard.public void setTSelLocal(byte[] tSelLocal)
tSelLocal
- the local/calling T-SEL. If null the T-SEL will be omitted. No maximum size is defined by the
standard.public void setResponseTimeout(int timeout)
ClientAssociation
that is created using this ClientSap.
timeout
- the response timeout in milliseconds. The default is 20000.public void setMessageFragmentTimeout(int timeout)
timeout
- the timeout in milliseconds. The default is 10000.public ClientAssociation associate(java.net.InetAddress address, int port, java.lang.String authenticationParameter) throws java.io.IOException
address
- the address to connect to.port
- the port to connect to. Usually the MMS port is 102.authenticationParameter
- an optional authentication parameters that is transmitted. It will be omitted if equal to null.
java.io.IOException
- if any kind of error occurs trying build up the association.public ClientAssociation associate(java.net.InetAddress address, int port, java.lang.String authenticationParameter, java.net.InetAddress localAddr, int localPort) throws java.io.IOException
address
- the address to connect to.port
- the port to connect to. Usually the MMS port is 102.authenticationParameter
- an optional authentication parameters that is transmitted. It will be omitted if equal to null.
java.io.IOException
- if any kind of error occurs trying build up the association.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |