com.goldencode.p2j.util

Class ServerImpl

java.lang.Object

com.goldencode.p2j.util.HandleResource

com.goldencode.p2j.util.HandleChain

com.goldencode.p2j.util.ServerImpl

All Implemented Interfaces:

SessionListener, AsyncRequestCountAttribute, AsyncRequestListener, CommonHandle, CommonHandleChain, Connectable, ConnectableServer, Deletable, FirstLastProcedureAttribute, InstantiatingProcedure, Nameable, RequestResponseInfo, Server, SslServerAttribute, SubTypeAttribute, WrappedResource, Printable

public class ServerImpl
extends HandleChain
implements Server, AsyncRequestCountAttribute, FirstLastProcedureAttribute, SslServerAttribute, SubTypeAttribute, ConnectableServer, SessionListener, AsyncRequestListener

A class for implementing APPSERVER methods and attributes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	ServerImpl.AsyncInvoker Provides a mechanism of performing asynchronous requests, by hiding the operating state of this server (State-free or State-managed).
private class	ServerImpl.SessionFreeInvoker Asynchronous invoker implementation for Session-free operating mode.
private class	ServerImpl.SessionManagedInvoker Asynchronous invoker implementation for Session-managed operating mode.

Field Summary

Fields

Modifier and Type	Field and Description
private long	asyncRequestCount Count the number of active async requests.
private java.lang.Thread	cancelReqTimer The currently active timer thread which will cancel the async requests.
private ClientType[]	clientTypes The client types associated with this server handle.
private ProxyProcedureWrapper	firstProcedure The first procedure in this server's proxy procedure list.
private ServerHelper	helper The server helper for this server, set after the connect(java.lang.String) method is called.
private ServerImpl.AsyncInvoker	invoker An special instance used to perform async request.
private ProxyProcedureWrapper	lastProcedure The last procedure in this server's proxy procedure list.
private static CentralLogger	LOG Logger
private object<? extends OerequestInfo>	requestInfo The reference to the REQUEST-INFO attribute.
private object<? extends OerequestInfo>	responseInfo The reference to the RESPONSE-INFO attribute.
private boolean	valid Flag indicating if the server is valid.

Fields inherited from class com.goldencode.p2j.util.HandleChain

name, nextSibling, prevSibling, wa

Fields inherited from class com.goldencode.p2j.util.HandleResource

instProc, pm

Constructor Summary

Constructors

Constructor and Description
ServerImpl() Default constructor which initializes Server specific settings.

Method Summary

Modifier and Type	Method and Description
boolean	_connected() Method declaration for the CONNECTED() method, supported by web-services and server handles.
logical	cancelRequests() Cancel all running or queued requests.
logical	cancelRequestsAfter(int64 timeSec) Calls the cancelRequests() method when the specified number of seconds have passed.
logical	cancelRequestsAfter(integer timeSec) Calls the cancelRequests() method when the specified number of seconds have passed.
logical	cancelRequestsAfter(long timeSec) Calls the cancelRequests() method when the specified number of seconds have passed; if another timer exists for this server, it will be terminated and a new timer will start.
logical	connect(character options) Method declaration for the CONNECT() procedure supported by web-services and server handles.
logical	connect(character options, character user) Method declaration for the CONNECT() procedure supported by web-services and server handles.
logical	connect(character options, character user, character pwd) Method declaration for the CONNECT() procedure supported by web-services and server handles.
logical	connect(character options, character user, character pwd, character serverInfo) Method declaration for the CONNECT() procedure supported by web-services and server handles.
logical	connect(java.lang.String options) Method declaration for the CONNECT() procedure supported by web-services and server handles.
logical	connected() Method declaration for the CONNECTED() method, supported by web-services and server handles.
private boolean	connectToAppServer(java.util.Map<java.lang.String,java.lang.String> parms, character user, character pwd, character serverInfo) Connect to an appserver using the specified parameters.
private boolean	connectToWebService(java.util.Map<java.lang.String,java.lang.String> parms) Connect to a web service, using the specified parameters.
logical	disconnect() Method declaration for the DISCONNECT() method supported by web-services and server handles.
private logical	disconnectImpl(boolean disconnecting) Method declaration for the DISCONNECT() method supported by web-services and server handles.
handle	firstProcedure() Returns the first entry in the list of persistent procedures or procedure objects.
private ServerImpl.AsyncInvoker	getAsyncInvoker() Get the asynchronous invoker for this server; if invoker is null, it will create a ServerImpl.SessionManagedInvoker if the server is in the Session-managed operating mode or a ServerImpl.SessionFreeInvoker if the server is in the Session-free operating mode.
integer	getAsyncRequestCount() Returns the number of asynchronous requests.
character	getClientConnectionId() This returns the id for the AppServer connection to this handle.
ClientType[]	getClientTypes() Returns the client types associated with this server handle.
handle	getFirstAsyncRequest() Returns a handle to the first asynchronous requests in the AppServer or WebService list of asynchronous requests.
handle	getLastAsyncRequest() Returns a handle to the last asynchronous requests in the AppServer or WebService list of asynchronous requests.
object<? extends OerequestInfo>	getRequestInfo() Get the REQUEST-INFO legacy attribute.
object<? extends OerequestInfo>	getResponseInfo() Get the RESPONSe-INFO legacy attribute.
(package private) ServerHelper	getServerHelper() Get the helper for this server resource.
character	getSslServerName() Java implementation for getting the SSL-SERVER-NAME attribute which contains the SSL server name if the connection is made as SSL.
character	getSubType() Returns the subtype of the handle.
(package private) boolean	hasAsyncRequests() Check if the server has running async requests.
protected boolean	hasNameReadOnly() Check if this resource supports the NAME attribute in read-only mode.
void	initialize(Session session) This method is called when the session is starting, just after the context was created.
void	invokeAsync(AsyncRequestImpl request) Invoke the given request on this server.
static boolean	isServer(handle h) Check if the given handle refers a server resource.
(package private) boolean	isWebService() Check if this server is connected to a web-service.
handle	lastProcedure() Returns the first entry in the list of persistent procedures or procedure objects.
void	notifyFinish() Notification that a remote procedure invoked via this server is finished.
void	notifyStart() Notification that a remote procedure is invoked via this server.
private java.util.Map<java.lang.String,java.lang.String>	parseOptions(character options) Parse and validate the given options; a map is returned with each parameters's value.
protected boolean	resourceDelete() Delete the resource.
(package private) void	setFirstProcedure(ProxyProcedureWrapper proc) Set the first proxy procedure of this server's chain.
(package private) void	setLastProcedure(ProxyProcedureWrapper proc) Set the last proxy procedure of this server's chain.
void	setSubType(character value) Sets the the subtype of the object.
void	setSubType(java.lang.String value) Sets the the subtype of the object.
void	terminate(Session session) This method is called when the session is ending.
boolean	valid() Reports if this object is valid for use (has not been deleted).

Methods inherited from class com.goldencode.p2j.util.HandleChain

_name, delete, firstResource, firstResource, getHead, getNextSibling, getNextSibling, getPrevSibling, getPrevSibling, getPrivateData, getTail, hasName, hasNameConstraints, hasNextSibling, hasParent, hasPrevSibling, hasPrivateData, interlink, isChained, lastResource, lastResource, moveInChain, name, name, name, readOnlyError, readOnlyError, resolveChainType, setHead, setNextSibling, setNextSibling, setPrevSibling, setPrevSibling, setPrivateData, setPrivateData, setPrivateData, validateName

Methods inherited from class com.goldencode.p2j.util.HandleResource

_instantiatingProcedure, addToPool, doDelete, equals, hashCode, id, id, implicitDeletion, incrementTrigger, instantiatingProcedure, invalidAttribute, processResource, registerResource, resourceType, setInstantiatingProcedure, toString, type, unableToAssignUnknown, unknown

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.goldencode.p2j.util.CommonHandleChain

getNextSibling, getPrevSibling, getPrivateData, setPrivateData, setPrivateData

Methods inherited from interface com.goldencode.p2j.util.CommonHandle

readOnlyError, readOnlyError, resourceType

Methods inherited from interface com.goldencode.p2j.util.WrappedResource

id, id, unknown

Methods inherited from interface com.goldencode.p2j.util.Nameable

name, name, name

Methods inherited from interface com.goldencode.util.Printable

asString, print

Methods inherited from interface com.goldencode.p2j.util.Deletable

allowDelete

Field Detail

LOG

private static final CentralLogger LOG

Logger

helper

private ServerHelper helper

The server helper for this server, set after the connect(java.lang.String) method is called.

firstProcedure

private ProxyProcedureWrapper firstProcedure

The first procedure in this server's proxy procedure list.

lastProcedure

private ProxyProcedureWrapper lastProcedure

The last procedure in this server's proxy procedure list.

valid

private boolean valid

Flag indicating if the server is valid.

asyncRequestCount

private long asyncRequestCount

Count the number of active async requests.

cancelReqTimer

private java.lang.Thread cancelReqTimer

The currently active timer thread which will cancel the async requests. May be null if no timer is active.

invoker

private ServerImpl.AsyncInvoker invoker

An special instance used to perform async request.

requestInfo

private object<? extends OerequestInfo> requestInfo

The reference to the REQUEST-INFO attribute.

responseInfo

private object<? extends OerequestInfo> responseInfo

The reference to the RESPONSE-INFO attribute.

clientTypes

private ClientType[] clientTypes

The client types associated with this server handle. Depends on the connect call.

Constructor Detail

ServerImpl

public ServerImpl()

Default constructor which initializes Server specific settings.

Method Detail

isServer

public static boolean isServer(handle h)

Check if the given handle refers a server resource.

Parameters:

h -

Returns:

true if the handle's resource is a server.

getClientTypes

public ClientType[] getClientTypes()

Returns the client types associated with this server handle. Depends on the connect call.

Returns:

See above.

invokeAsync

public void invokeAsync(AsyncRequestImpl request)

Invoke the given request on this server.

Parameters:

request - The async request to be executed.

valid

public boolean valid()

Reports if this object is valid for use (has not been deleted).

Specified by:

valid in interface WrappedResource

Returns:

true if we are valid (can be used).

getRequestInfo

public object<? extends OerequestInfo> getRequestInfo()

Get the REQUEST-INFO legacy attribute.

Specified by:

getRequestInfo in interface RequestResponseInfo

Returns:

See above.

getResponseInfo

public object<? extends OerequestInfo> getResponseInfo()

Get the RESPONSe-INFO legacy attribute.

Specified by:

getResponseInfo in interface RequestResponseInfo

Returns:

See above.

getAsyncRequestCount

public integer getAsyncRequestCount()

Returns the number of asynchronous requests.

Specified by:

getAsyncRequestCount in interface AsyncRequestCountAttribute

Returns:

See above.

getSubType

public character getSubType()

Returns the subtype of the handle.

For SERVER handles this represents the type of server to which this is connected. The possible values are "APPSERVER" and "WEBSERVICE".

Specified by:

getSubType in interface SubTypeAttribute

Returns:

See above.

setSubType

public void setSubType(character value)

Sets the the subtype of the object.

Specified by:

setSubType in interface SubTypeAttribute

Parameters:

value - The new value of the subtype object attribute.

setSubType

public void setSubType(java.lang.String value)

Sets the the subtype of the object.

Specified by:

setSubType in interface SubTypeAttribute

Parameters:

value - The new value of the subtype object attribute.

getSslServerName

public character getSslServerName()

Java implementation for getting the SSL-SERVER-NAME attribute which contains the SSL server name if the connection is made as SSL.

Specified by:

getSslServerName in interface SslServerAttribute

Returns:

The SSL server name, if the connection is made as SSL or unknown otherwise

firstProcedure

public handle firstProcedure()

Returns the first entry in the list of persistent procedures or procedure objects.

Specified by:

firstProcedure in interface FirstLastProcedureAttribute

Returns:

See above.

lastProcedure

public handle lastProcedure()

Returns the first entry in the list of persistent procedures or procedure objects.

Specified by:

lastProcedure in interface FirstLastProcedureAttribute

Returns:

See above.

getClientConnectionId

public character getClientConnectionId()

This returns the id for the AppServer connection to this handle. For Web Services, the returned value will be an empty string.

Specified by:

getClientConnectionId in interface Server

Returns:

See above.

getFirstAsyncRequest

public handle getFirstAsyncRequest()

Returns a handle to the first asynchronous requests in the AppServer or WebService list of asynchronous requests.

Specified by:

getFirstAsyncRequest in interface Server

Returns:

See above.

getLastAsyncRequest

public handle getLastAsyncRequest()

Returns a handle to the last asynchronous requests in the AppServer or WebService list of asynchronous requests.

Specified by:

getLastAsyncRequest in interface Server

Returns:

See above.

cancelRequests

public logical cancelRequests()

Cancel all running or queued requests. Depending on the server's operating mode, the active requests will treat a cancel command differently:

• Session-managed: STOP is sent to the executing request; the COMPLETE flag will remain set to TRUE. All the queued requests are purged and their CANCELLED flag is set to TRUE.
• Session-free: STOP is sent to all requests; their CANCELLED flag is set to TRUE.

Specified by:

cancelRequests in interface Server

Returns:

true if CANCEL-REQUESTS() method returns true, false otherwise.

cancelRequestsAfter

public logical cancelRequestsAfter(integer timeSec)

Calls the cancelRequests() method when the specified number of seconds have passed.

Specified by:

cancelRequestsAfter in interface Server

Parameters:

timeSec - The time in seconds after the cancelRequests() method will be called. 4GL allows only integer or int64 values for this parameter.

Returns:

false if timer cannot be set or cancelRequests()'s result otherwise

cancelRequestsAfter

public logical cancelRequestsAfter(int64 timeSec)

Calls the cancelRequests() method when the specified number of seconds have passed.

Specified by:

cancelRequestsAfter in interface Server

Parameters:

timeSec - The time in seconds after the cancelRequests() method will be called. 4GL allows only integer or int64 values for this parameter.

Returns:

false if timer cannot be set or cancelRequests()'s result otherwise

cancelRequestsAfter

public logical cancelRequestsAfter(long timeSec)

Calls the cancelRequests() method when the specified number of seconds have passed; if another timer exists for this server, it will be terminated and a new timer will start.

If timeSec is zero or negative, then the current timer will be stopped.

Specified by:

cancelRequestsAfter in interface Server

Parameters:

timeSec - The time in seconds after the cancelRequests() method will be called. 4GL allows only integer or int64 values for this parameter.

Returns:

false if timer cannot be set or cancelRequests()'s result otherwise

connect

public logical connect(java.lang.String options)

Method declaration for the CONNECT() procedure supported by web-services and server handles.

Specified by:

connect in interface Connectable

Parameters:

options - The set of parameters to establish the connection. 4GL allows only character values for this parameter.

Returns:

true if connection succeeded, or false otherwise

connect

public logical connect(character options)

Method declaration for the CONNECT() procedure supported by web-services and server handles.

Specified by:

connect in interface Connectable

Parameters:

options - The set of parameters to establish the connection. 4GL allows only character values for this parameter.

Returns:

true if connection succeeded, or false otherwise

connect

public logical connect(character options,
                       character user)

Method declaration for the CONNECT() procedure supported by web-services and server handles.

Specified by:

connect in interface ConnectableServer

Parameters:

options - The set of parameters to establish the connection. 4GL allows only character values for this parameter.

user - The user to send to the CONNECT procedure on the appserver side.

Returns:

true if connection succeeded, or false otherwise

connect

public logical connect(character options,
                       character user,
                       character pwd)

Method declaration for the CONNECT() procedure supported by web-services and server handles.

Specified by:

connect in interface ConnectableServer

Parameters:

options - The set of parameters to establish the connection. 4GL allows only character values for this parameter.

user - The user to send to the CONNECT procedure on the appserver side.

pwd - The password to send to the CONNECT procedure on the appserver side.

Returns:

true if connection succeeded, or false otherwise

connect

public logical connect(character options,
                       character user,
                       character pwd,
                       character serverInfo)

Method declaration for the CONNECT() procedure supported by web-services and server handles.

Specified by:

connect in interface ConnectableServer

Parameters:

options - The set of parameters to establish the connection. 4GL allows only character values for this parameter.

user - The user to send to the CONNECT procedure on the appserver side.

pwd - The password to send to the CONNECT procedure on the appserver side.

serverInfo - Other info to send to the CONNECT procedure on the appserver side.

Returns:

true if connection succeeded, or false otherwise

connected

public logical connected()

Method declaration for the CONNECTED() method, supported by web-services and server handles. This will return true if the web service is connected or false otherwise.

Specified by:

connected in interface Connectable

Returns:

true if the server is connected or false otherwise.

_connected

public boolean _connected()

Method declaration for the CONNECTED() method, supported by web-services and server handles. This will return true if the web service is connected or false otherwise.

Returns:

true if the server is connected or false otherwise.

disconnect

public logical disconnect()

Method declaration for the DISCONNECT() method supported by web-services and server handles. This will attempt to disconnect the resource and returns true if succeeded or false otherwise.

Specified by:

disconnect in interface Connectable

Returns:

true if disconnect succeeded or false otherwise.

terminate

public void terminate(Session session)

This method is called when the session is ending. It disconnects the current server, if the session which created it is ending.

Specified by:

terminate in interface SessionListener

Parameters:

session - The session that is ending.

initialize

public void initialize(Session session)

This method is called when the session is starting, just after the context was created.

Specified by:

initialize in interface SessionListener

Parameters:

session - The session that is starting.

notifyStart

public void notifyStart()

Notification that a remote procedure is invoked via this server.

Specified by:

notifyStart in interface AsyncRequestListener

notifyFinish

public void notifyFinish()

Notification that a remote procedure invoked via this server is finished.

Specified by:

notifyFinish in interface AsyncRequestListener

hasNameReadOnly

protected boolean hasNameReadOnly()

Check if this resource supports the NAME attribute in read-only mode.

Overrides:

hasNameReadOnly in class HandleChain

Returns:

Always false.

hasAsyncRequests

boolean hasAsyncRequests()

Check if the server has running async requests. If so, display appropriate error message.

Returns:

true if the server has running async requests.

getServerHelper

ServerHelper getServerHelper()

Get the helper for this server resource.

Returns:

See above.

isWebService

boolean isWebService()

Check if this server is connected to a web-service.

Returns:

See above.

setFirstProcedure

void setFirstProcedure(ProxyProcedureWrapper proc)

Set the first proxy procedure of this server's chain.

Parameters:

proc - The procedure instance.

setLastProcedure

void setLastProcedure(ProxyProcedureWrapper proc)

Set the last proxy procedure of this server's chain.

Parameters:

proc - The procedure instance.

resourceDelete

protected boolean resourceDelete()

Delete the resource. If the server is still connected, delete is not possible.

Overrides:

resourceDelete in class HandleResource

Returns:

true if the resource was deleted.

connectToWebService

private boolean connectToWebService(java.util.Map<java.lang.String,java.lang.String> parms)

Connect to a web service, using the specified parameters.

Parameters:

parms - The connection parameters.

Returns:

true if the connection was possible.

connectToAppServer

private boolean connectToAppServer(java.util.Map<java.lang.String,java.lang.String> parms,
                                   character user,
                                   character pwd,
                                   character serverInfo)

Connect to an appserver using the specified parameters.

Parameters:

parms - The set of parameters to establish the connection. 4GL allows only character values for this parameter.

user - The user to send to the CONNECT procedure on the appserver side.

pwd - The password to send to the CONNECT procedure on the appserver side.

serverInfo - Other info to send to the CONNECT procedure on the appserver side.

Returns:

true if the connection was possible.

disconnectImpl

private logical disconnectImpl(boolean disconnecting)

Method declaration for the DISCONNECT() method supported by web-services and server handles. This will attempt to disconnect the resource and returns true if succeeded or false otherwise.

Parameters:

disconnecting - Flag indicating if the session is being terminated.

Returns:

true if disconnect succeeded or false otherwise.

parseOptions

private java.util.Map<java.lang.String,java.lang.String> parseOptions(character options)

Parse and validate the given options; a map is returned with each parameters's value. If a parameter doesn't have a value, the map will contain null.

Parameters:

options - The options from which the parameters will be extracted.

Returns:

The parameter-to-value map.

getAsyncInvoker

private ServerImpl.AsyncInvoker getAsyncInvoker()

Get the asynchronous invoker for this server; if invoker is null, it will create a ServerImpl.SessionManagedInvoker if the server is in the Session-managed operating mode or a ServerImpl.SessionFreeInvoker if the server is in the Session-free operating mode.

Returns:

See above.