com.sabratec.applinx.baseobject

Class GXInnerClientBaseObjectFactory

java.lang.Object

com.sabratec.applinx.baseobject.GXInnerClientBaseObjectFactory

public class GXInnerClientBaseObjectFactory
extends Object

General factory to create connected / attached base objects, detach and disconnect them from ApplinX server.

There are three acceptable protocols, which dictate different communication modes between the base object and the server.

• ApplinX - Used to communicate with the server over a socket.
• Local (direct) - Used to communicate with an in-process server. All base objects communicate with a single server object. Currently used when the server is loaded as a servlet.

This class was created for internal use, please don't use it directly , use GXClientBaseObjectFactory instead

Constructor Summary

Constructors

Constructor and Description
GXInnerClientBaseObjectFactory()

Method Summary

Modifier and Type	Method and Description
static void	detachSession(GXIReadOnlyBaseObject baseObject) Detaches the given base object from ApplinX server.
static void	endSession(GXEndSessionRequest endSessionRequest) Ends a session on ApplinX server according to the given end session request.
static void	endSession(GXIClientBaseObject baseObject) Ends the session of the given base object.
static GXIClientBaseObject	getBaseObject(GXAttachToSessionRequest attachRequest) Creates a base object, and attaches it to an existing session on ApplinX server.
static GXIClientBaseObject	getBaseObject(GXCreateSessionRequest connectRequest) Creates a base object, and connects it to ApplinX server and the host.
static GXIReadOnlyBaseObject	getReadOnlyBaseObject(GXAttachToSessionRequest attachRequest) Creates a read-only base object, and attaches it to an existing session on ApplinX server.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GXInnerClientBaseObjectFactory

public GXInnerClientBaseObjectFactory()

Method Detail

getBaseObject

public static GXIClientBaseObject getBaseObject(GXCreateSessionRequest connectRequest)
                                         throws GXConnectionException,
                                                GXGeneralException

Creates a base object, and connects it to ApplinX server and the host.

Parameters:

connectRequest - the connection parameters.

Returns:

connected base object.

Throws:

GXConnectionException - when the connection to the host / ApplinX server was not successful.

GXGeneralException - other exception thrown in the process.

getBaseObject

public static GXIClientBaseObject getBaseObject(GXAttachToSessionRequest attachRequest)
                                         throws GXConnectionException,
                                                GXGeneralException

Creates a base object, and attaches it to an existing session on ApplinX server. There could be only one attached BaseObject to the same session at a time. This method is meaningless when using localserver:// protocol.

Parameters:

attachRequest - the connection parameters.

Returns:

attached base object.

Throws:

GXConnectionException - when the connection to the host / ApplinX server was not successful.

GXGeneralException - other exception thrown in the process.

getReadOnlyBaseObject

public static GXIReadOnlyBaseObject getReadOnlyBaseObject(GXAttachToSessionRequest attachRequest)
                                                   throws GXConnectionException,
                                                          GXGeneralException

Creates a read-only base object, and attaches it to an existing session on ApplinX server. There could be several read-only BaseObject attached to the server at the same time. This method is meaningless when using localserver:// protocol.

Parameters:

attachRequest - the connection parameters.

Returns:

attached base object.

Throws:

GXConnectionException - when the connection to ApplinX server was not successful.

GXGeneralException - other exception thrown in the process.

detachSession

public static void detachSession(GXIReadOnlyBaseObject baseObject)
                          throws GXGeneralException,
                                 GXConnectionException

Detaches the given base object from ApplinX server. This method is meaningless when using localserver:// protocol.

Throws:

GXConnectionException - when the connection to the host / ApplinX server was not successful.

GXGeneralException - other exception thrown in the process.

endSession

public static void endSession(GXIClientBaseObject baseObject)
                       throws GXGeneralException,
                              GXConnectionException

Ends the session of the given base object.

Parameters:

baseObject - the session object.

Throws:

GXConnectionException - when the connection to the host / ApplinX server was not successful.

GXGeneralException - other exception thrown in the process.

endSession

public static void endSession(GXEndSessionRequest endSessionRequest)
                       throws GXGeneralException,
                              GXConnectionException

Ends a session on ApplinX server according to the given end session request.

Parameters:

endSessionRequest - the session parameters.

Throws:

GXConnectionException - when the connection to the host / ApplinX server was not successful.

GXGeneralException - other exception thrown in the process.