Top Description Fields Constructors Methods
com.sun.star.lib.connections.websocket

public final Class websocketConnector

extends Object
implements com.sun.star.connection.XConnector
Class Inheritance
Imports
com.sun.star.comp.loader.FactoryHelper, com.sun.star.connection.ConnectionSetupException, com.sun.star.connection.NoConnectException, com.sun.star.connection.XConnection, com.sun.star.connection.XConnector, com.sun.star.lang.XMultiServiceFactory, com.sun.star.lang.XSingleServiceFactory, com.sun.star.registry.XRegistryKey, java.io.IOException, java.net.InetAddress, .Socket, .URISyntaxException, .UnknownHostException
A component that implements the XConnector interface.

The websocketConnector is a specialized component that uses websockets for communication. The websocketConnector is generally used by the com.sun.star.connection.Connector service.

See Also
com.sun.star.connection.XAcceptor, com.sun.star.connection.XConnection, com.sun.star.connection.XConnector, com.sun.star.comp.loader.JavaLoader

Field Summary

Modifier and TypeField and Description
public static final String
__serviceName

The name of the service.

private boolean
connected

Constructor Summary

AccessConstructor and Description
public
websocketConnector()

Method Summary

Modifier and TypeMethod and Description
public static com.sun.star.lang.XSingleServiceFactory

Returns:

an XSingleServiceFactory for creating the component.
__getServiceFactory(String
the name of the implementation for which a service is requested.
implName, com.sun.star.lang.XMultiServiceFactory
the service manager to be used (if needed).
multiFactory, com.sun.star.registry.XRegistryKey
the registry key.
regKey)

Returns a factory for creating the service.

public synchronized com.sun.star.connection.XConnection

Returns:

an XConnection to the server.
connect(String
the description of the connection.
connectionDescription)

Connects via the described websocket to a waiting server.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

__serviceNameback to summary
public static final String __serviceName

The name of the service.

The JavaLoader accesses this through reflection.

See Also
com.sun.star.comp.loader.JavaLoader
connectedback to summary
private boolean connected

Constructor Detail

websocketConnectorback to summary
public websocketConnector()

Method Detail

__getServiceFactoryback to summary
public static com.sun.star.lang.XSingleServiceFactory __getServiceFactory(String implName, com.sun.star.lang.XMultiServiceFactory multiFactory, com.sun.star.registry.XRegistryKey regKey)

Returns a factory for creating the service.

This method is called by the JavaLoader.

Parameters
implName:String

the name of the implementation for which a service is requested.

multiFactory:com.sun.star.lang.XMultiServiceFactory

the service manager to be used (if needed).

regKey:com.sun.star.registry.XRegistryKey

the registry key.

Returns:com.sun.star.lang.XSingleServiceFactory

an XSingleServiceFactory for creating the component.

See Also
com.sun.star.comp.loader.JavaLoader
connectback to summary
public synchronized com.sun.star.connection.XConnection connect(String connectionDescription) throws com.sun.star.connection.NoConnectException, com.sun.star.connection.ConnectionSetupException

Connects via the described websocket to a waiting server.

The connection description has the following format: type*(key=value), where type should be websocket (ignoring case). Supported keys (ignoring case) currently are

url
The URL the websocket server is listening on, starting with either ws:// or wss://
Parameters
connectionDescription:String

the description of the connection.

Returns:com.sun.star.connection.XConnection

an XConnection to the server.

See Also
com.sun.star.connection.XAcceptor, com.sun.star.connection.XConnection