org.marketcetera.util.rpc

Class RpcServer<SessionClazz>

java.lang.Object

org.marketcetera.util.rpc.RpcServer<SessionClazz>

All Implemented Interfaces:

RpcServerServices<SessionClazz>, UsesPort, org.springframework.context.Lifecycle

public class RpcServer<SessionClazz>
extends Object
implements org.springframework.context.Lifecycle, RpcServerServices<SessionClazz>, UsesPort

Provides RPC services.

Since:

2.4.0

Version:

$Id: RpcServer.java 17411 2017-04-28 14:50:38Z colin $

Author:

Colin DuPlantis

Constructor Summary

Constructors

Constructor and Description
RpcServer() Create a new RpcServer instance.

Method Summary

Methods

Modifier and Type	Method and Description
Authenticator	getAuthenticator() Get the authenticator value.
ContextClassProvider	getContextClassProvider() Get the contextClassProvider value.
String	getDescription() Get the description value.
boolean	getNoDelay() Get the noDelay value.
Collection<PortDescriptor>	getPortDescriptors() Get the ports that this implementor uses.
int	getReceiveBufferSize() Get the receiveBufferSize value.
String	getRpcHostname() Get the rpcHostname value.
int	getRpcPort() Get the rpcPort value.
int	getSendBufferSize() Get the sendBufferSize value.
List<RpcServiceSpec<SessionClazz>>	getServiceSpecs() Get the serviceSpecs value.
SessionManager<SessionClazz>	getSessionManager() Get the sessionManager value.
int	getThreadPoolCore() Get the threadPoolCore value.
int	getThreadPoolMax() Get the threadPoolMax value.
boolean	isRunning()
SessionId	login(RpcCredentials inCredentials) Authenticates the given credentials.
void	logout(String inSessionIdValue) Invalidates the given session.
String	marshal(Object inObject) Marshals the given object to XML.
void	setAuthenticator(Authenticator inAuthenticator) Sets the authenticator value.
void	setContextClassProvider(ContextClassProvider inContextClassProvider) Sets the contextClassProvider value.
void	setDescription(String inDescription) Sets the description value.
void	setHostname(String inRpcHostname) Sets the rpcHostname value.
void	setNoDelay(boolean inNoDelay) Sets the noDelay value.
void	setPort(int inRpcPort) Sets the rpcPort value.
void	setReceiveBufferSize(int inReceiveBufferSize) Sets the receiveBufferSize value.
void	setSendBufferSize(int inSendBufferSize) Sets the sendBufferSize value.
void	setServiceSpecs(List<RpcServiceSpec<SessionClazz>> inServiceSpecs) Sets the serviceSpecs value.
void	setSessionManager(SessionManager<SessionClazz> inSessionManager) Sets the sessionManager value.
void	setThreadPoolCore(int inThreadPoolCore) Sets the threadPoolCore value.
void	setThreadPoolMax(int inThreadPoolMax) Sets the threadPoolMax value.
void	start()
void	stop()
<Clazz> Clazz	unmarshall(String inData) Unmarshals the given XML stream.
SessionHolder<SessionClazz>	validateAndReturnSession(String inSessionIdValue) Validates that the given session is active.

Methods inherited from class java.lang.Object

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

Constructor Detail

RpcServer

public RpcServer()

Create a new RpcServer instance.

Method Detail

isRunning

public boolean isRunning()

Specified by:

isRunning in interface org.springframework.context.Lifecycle

start

@PostConstruct
public void start()

Specified by:

start in interface org.springframework.context.Lifecycle

stop

@PreDestroy
public void stop()

Specified by:

stop in interface org.springframework.context.Lifecycle

getServiceSpecs

public List<RpcServiceSpec<SessionClazz>> getServiceSpecs()

Get the serviceSpecs value.

Returns:

a List<RpcServiceSpec> value

setServiceSpecs

public void setServiceSpecs(List<RpcServiceSpec<SessionClazz>> inServiceSpecs)

Sets the serviceSpecs value.

Parameters:

inServiceSpecs - a List<RpcServiceSpec> value

getSendBufferSize

public int getSendBufferSize()

Get the sendBufferSize value.

Returns:

an int value

setSendBufferSize

public void setSendBufferSize(int inSendBufferSize)

Sets the sendBufferSize value.

Parameters:

inSendBufferSize - an int value

getReceiveBufferSize

public int getReceiveBufferSize()

Get the receiveBufferSize value.

Returns:

an int value

setReceiveBufferSize

public void setReceiveBufferSize(int inReceiveBufferSize)

Sets the receiveBufferSize value.

Parameters:

inReceiveBufferSize - an int value

getNoDelay

public boolean getNoDelay()

Get the noDelay value.

Returns:

a boolean value

setNoDelay

public void setNoDelay(boolean inNoDelay)

Sets the noDelay value.

Parameters:

inNoDelay - a boolean value

getThreadPoolCore

public int getThreadPoolCore()

Get the threadPoolCore value.

Returns:

an int value

setThreadPoolCore

public void setThreadPoolCore(int inThreadPoolCore)

Sets the threadPoolCore value.

Parameters:

inThreadPoolCore - an int value

getThreadPoolMax

public int getThreadPoolMax()

Get the threadPoolMax value.

Returns:

an int value

setThreadPoolMax

public void setThreadPoolMax(int inThreadPoolMax)

Sets the threadPoolMax value.

Parameters:

inThreadPoolMax - an int value

getRpcHostname

public String getRpcHostname()

Get the rpcHostname value.

Returns:

a String value

setHostname

public void setHostname(String inRpcHostname)

Sets the rpcHostname value.

Parameters:

inRpcHostname - a String value

getRpcPort

public int getRpcPort()

Get the rpcPort value.

Returns:

an int value

setPort

public void setPort(int inRpcPort)

Sets the rpcPort value.

Parameters:

inRpcPort - an int value

getAuthenticator

public Authenticator getAuthenticator()

Get the authenticator value.

Returns:

an Authenticator value

setAuthenticator

public void setAuthenticator(Authenticator inAuthenticator)

Sets the authenticator value.

Parameters:

inAuthenticator - an Authenticator value

getSessionManager

public SessionManager<SessionClazz> getSessionManager()

Get the sessionManager value.

Returns:

a SessionManager<SessionClazz> value

setSessionManager

public void setSessionManager(SessionManager<SessionClazz> inSessionManager)

Sets the sessionManager value.

Parameters:

inSessionManager - a SessionManager<SessionClazz> value

getContextClassProvider

public ContextClassProvider getContextClassProvider()

Get the contextClassProvider value.

Returns:

a ContextClassProvider value

setContextClassProvider

public void setContextClassProvider(ContextClassProvider inContextClassProvider)

Sets the contextClassProvider value.

Parameters:

inContextClassProvider - a ContextClassProvider value

login

public SessionId login(RpcCredentials inCredentials)

Description copied from interface: RpcServerServices

Authenticates the given credentials.

Specified by:

login in interface RpcServerServices<SessionClazz>

Parameters:

inCredentials - an RpcCredentials value

Returns:

a SessionId value

logout

public void logout(String inSessionIdValue)

Description copied from interface: RpcServerServices

Invalidates the given session.

Specified by:

logout in interface RpcServerServices<SessionClazz>

Parameters:

inSessionIdValue - a String value

validateAndReturnSession

public SessionHolder<SessionClazz> validateAndReturnSession(String inSessionIdValue)

Description copied from interface: RpcServerServices

Validates that the given session is active.

Specified by:

validateAndReturnSession in interface RpcServerServices<SessionClazz>

Parameters:

inSessionIdValue - a String value

Returns:

a SessionHolder<SessionClazz> value

marshal

public String marshal(Object inObject)
               throws JAXBException

Description copied from interface: RpcServerServices

Marshals the given object to XML.

Specified by:

marshal in interface RpcServerServices<SessionClazz>

Parameters:

inObject - an Object value

Returns:

a String value

Throws:

JAXBException - if an error occurs marshalling the object

unmarshall

public <Clazz> Clazz unmarshall(String inData)
                 throws JAXBException

Description copied from interface: RpcServerServices

Unmarshals the given XML stream.

Specified by:

unmarshall in interface RpcServerServices<SessionClazz>

Parameters:

inData - a String value

Returns:

a Clazz value

Throws:

JAXBException - if an error occurs unmarshalling the stream

getPortDescriptors

public Collection<PortDescriptor> getPortDescriptors()

Description copied from interface: UsesPort

Get the ports that this implementor uses.

Specified by:

getPortDescriptors in interface UsesPort

Returns:

a Collection<PortDescriptor> value

getDescription

public String getDescription()

Get the description value.

Returns:

a String value

setDescription

public void setDescription(String inDescription)

Sets the description value.

Parameters:

inDescription - a String value