org.marketcetera.util.rpc

Interface RpcServerServices<SessionClazz>

All Known Implementing Classes:

RpcServer

public interface RpcServerServices<SessionClazz>

Provides common RPC server services.

Since:

2.4.0

Version:

$Id: RpcServerServices.java 16901 2014-05-11 16:14:11Z colin $

Author:

Colin DuPlantis

Method Summary

Methods

Modifier and Type	Method and Description
SessionId	login(RpcCredentials inCredentials) Authenticates the given credentials.
void	logout(String inSessionId) Invalidates the given session.
String	marshal(Object inObject) Marshals the given object to XML.
<Clazz> Clazz	unmarshall(String inData) Unmarshals the given XML stream.
SessionHolder<SessionClazz>	validateAndReturnSession(String inSessionId) Validates that the given session is active.

Method Detail

login

SessionId login(RpcCredentials inCredentials)

Authenticates the given credentials.

Parameters:

inCredentials - an RpcCredentials value

Returns:

a SessionId value

logout

void logout(String inSessionId)

Invalidates the given session.

Parameters:

inSessionId - a String value

validateAndReturnSession

SessionHolder<SessionClazz> validateAndReturnSession(String inSessionId)

Validates that the given session is active.

Parameters:

inSessionId - a String value

Returns:

a SessionHolder<SessionClazz> value

marshal

String marshal(Object inObject)
               throws JAXBException

Marshals the given object to XML.

Parameters:

inObject - an Object value

Returns:

a String value

Throws:

JAXBException - if an error occurs marshalling the object

unmarshall

<Clazz> Clazz unmarshall(String inData)
                 throws JAXBException

Unmarshals the given XML stream.

Parameters:

inData - a String value

Returns:

a Clazz value

Throws:

JAXBException - if an error occurs unmarshalling the stream