ch.icosys.popjava.core.broker

Class Broker

java.lang.Object

ch.icosys.popjava.core.broker.Broker

public final class Broker
extends java.lang.Object

This class is the base class of all broker-side parallel object. The broker is responsible to receive the requests from the interface-side and to execute them on the real object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Broker.State

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACTUAL_OBJECT_NAME_PREFIX
static java.lang.String	APPSERVICE_PREFIX
static int	BASIC_CALL_MAX_RANGE
static java.lang.String	CALLBACK_PREFIX
static java.lang.String	CODELOCATION_PREFIX
static int	CONSTRUCTOR_SEMANTIC_ID
static java.lang.String	JOB_SERVICE
static java.lang.String	NETWORK_UUID
static java.lang.String	OBJECT_NAME_PREFIX
static java.lang.String	POPJAVA_CONFIG_PREFIX
static int	REQUEST_QUEUE_TIMEOUT_MS
static java.lang.String	TRACKING
static java.lang.String	UPNP

Constructor Summary

Constructors

Constructor and Description
Broker(POPObject object)

Method Summary

Modifier and Type	Method and Description
void	clearResourceAfterInvoke(Request request) Remove the request from the request queue after invocation
void	finalizeRequest(Request request) Replace the request semantics if we are working with a PopJava Object with the corresponding local annotation.
protected boolean	findEndcoding(java.lang.String encoding) Look for a specific encoding
POPAccessPoint	getAccessPoint() Return the access point of this broker
java.lang.String	getLogPrefix() Return the prefix for log file
protected java.lang.Class<?>	getPOPObjectClass(java.lang.String className, java.net.URLClassLoader urlClassLoader) Return the class of the associated object
static POPRemoteCaller	getRemoteCaller() Get who is calling this method.
RequestQueue	getRequestQueue() The broker global request queue.
Broker.State	getState() Get information about the state of this broker
POPTracking	getTracked(POPRemoteCaller caller) Statistics on a single user.
POPRemoteCaller[]	getTrackingUsers() All the currently tracked users.
boolean	initialize(java.util.List<java.lang.String> argvs) Initialization of the broker-side
boolean	invoke(Request request) This method is responsible to dispatch the request between invokeConstructor and invokeMethod
boolean	isDaemon() Get information about the deamon mode of this broker
boolean	isTraking() Is tracking enabled on Broker side.
boolean	isUPNPEnabled() Returns true if UPNP is enabled
void	kill() Kill the broker and its associated object
static void	main(java.lang.String[] argvs) Entry point for the Broker.
void	onCloseConnection(java.lang.String source) Decrement de connection counter and exit the broker if there is no more connection
void	onNewConnection() Increment the connection counter
boolean	popCall(Request request) This method is responsible to handle the POP system call
boolean	sendException(ComboxConnection combox, POPException exception, int requestId) Send exception to the interface-side
void	sendResponse(ComboxConnection combox, POPBuffer buffer) Send response to the interface-side
void	serveRequest(Request request) This method is responsible to handle the broker-side semantics for a request
void	setState(Broker.State state) Set state information of this broker
void	treatRequests() Main loop of this broker

Methods inherited from class java.lang.Object

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

Field Detail

REQUEST_QUEUE_TIMEOUT_MS

public static final int REQUEST_QUEUE_TIMEOUT_MS

See Also:

Constant Field Values

BASIC_CALL_MAX_RANGE

public static final int BASIC_CALL_MAX_RANGE

See Also:

Constant Field Values

CONSTRUCTOR_SEMANTIC_ID

public static final int CONSTRUCTOR_SEMANTIC_ID

See Also:

Constant Field Values

CALLBACK_PREFIX

public static final java.lang.String CALLBACK_PREFIX

See Also:

Constant Field Values

CODELOCATION_PREFIX

public static final java.lang.String CODELOCATION_PREFIX

See Also:

Constant Field Values

OBJECT_NAME_PREFIX

public static final java.lang.String OBJECT_NAME_PREFIX

See Also:

Constant Field Values

ACTUAL_OBJECT_NAME_PREFIX

public static final java.lang.String ACTUAL_OBJECT_NAME_PREFIX

See Also:

Constant Field Values

APPSERVICE_PREFIX

public static final java.lang.String APPSERVICE_PREFIX

See Also:

Constant Field Values

JOB_SERVICE

public static final java.lang.String JOB_SERVICE

See Also:

Constant Field Values

POPJAVA_CONFIG_PREFIX

public static final java.lang.String POPJAVA_CONFIG_PREFIX

See Also:

Constant Field Values

NETWORK_UUID

public static final java.lang.String NETWORK_UUID

See Also:

Constant Field Values

TRACKING

public static final java.lang.String TRACKING

See Also:

Constant Field Values

UPNP

public static final java.lang.String UPNP

See Also:

Constant Field Values

Constructor Detail

Broker

public Broker(POPObject object)

Method Detail

finalizeRequest

public void finalizeRequest(Request request)

Replace the request semantics if we are working with a PopJava Object with the corresponding local annotation.

Parameters:

request - The request to be queued

invoke

public boolean invoke(Request request)
               throws java.lang.InterruptedException

This method is responsible to dispatch the request between invokeConstructor and invokeMethod

Parameters:

request - Request received from the interface-side

Returns:

true if the request has been treated correctly

Throws:

java.lang.InterruptedException - if the any semaphore's operation fail

clearResourceAfterInvoke

public void clearResourceAfterInvoke(Request request)

Remove the request from the request queue after invocation

Parameters:

request - Request to be removed

serveRequest

public void serveRequest(Request request)
                  throws java.lang.InterruptedException

This method is responsible to handle the broker-side semantics for a request

Parameters:

request - Request received from the interface-side

Throws:

java.lang.InterruptedException - if the any semaphore's operation fail

popCall

public boolean popCall(Request request)

This method is responsible to handle the POP system call

Parameters:

request - Request received from the interface-side

Returns:

true if the request has been treated correctly

kill

public void kill()

Kill the broker and its associated object

getAccessPoint

public POPAccessPoint getAccessPoint()

Return the access point of this broker

Returns:

Access point associated with this broker

treatRequests

public void treatRequests()
                   throws java.lang.InterruptedException

Main loop of this broker

Throws:

java.lang.InterruptedException - if the any semaphore's operation fail

onNewConnection

public void onNewConnection()

Increment the connection counter

onCloseConnection

public void onCloseConnection(java.lang.String source)

Decrement de connection counter and exit the broker if there is no more connection

isDaemon

public boolean isDaemon()

Get information about the deamon mode of this broker

Returns:

deamon mode

isTraking

public boolean isTraking()

Is tracking enabled on Broker side.

Returns:

true if tracking is turned on

getRemoteCaller

public static POPRemoteCaller getRemoteCaller()

Get who is calling this method.

Returns:

the remote caller of the calling thread, if it exists

getState

public Broker.State getState()

Get information about the state of this broker

Returns:

current state

setState

public void setState(Broker.State state)

Set state information of this broker

Parameters:

state - state to set to this broker

findEndcoding

protected boolean findEndcoding(java.lang.String encoding)

Look for a specific encoding

Parameters:

encoding - Encoding to look for

Returns:

true if the encoding is available

initialize

public boolean initialize(java.util.List<java.lang.String> argvs)

Initialization of the broker-side

Parameters:

argvs - Arguments

Returns:

true if the initialization process succeed

getPOPObjectClass

protected java.lang.Class<?> getPOPObjectClass(java.lang.String className,
                                               java.net.URLClassLoader urlClassLoader)
                                        throws java.lang.ClassNotFoundException

Return the class of the associated object

Parameters:

className - Name of the class

urlClassLoader - Path of the class

Returns:

Class object or null

Throws:

java.lang.ClassNotFoundException - thrown if the class is not found

main

public static void main(java.lang.String[] argvs)
                 throws java.lang.InterruptedException

Entry point for the Broker. This method is called when a new Broker is setup in a JVM.

Parameters:

argvs - arguments of the program

Throws:

java.lang.InterruptedException - if the any semaphore's operation fail

sendException

public boolean sendException(ComboxConnection combox,
                             POPException exception,
                             int requestId)

Send exception to the interface-side

Parameters:

combox - Combox to send the exception

exception - Exception to send

Returns:

true if the exception has been sent

sendResponse

public void sendResponse(ComboxConnection combox,
                         POPBuffer buffer)

Send response to the interface-side

Parameters:

combox - Combox to send the response

buffer - Buffer to send trough the combox

getLogPrefix

public java.lang.String getLogPrefix()

Return the prefix for log file

Returns:

log prefix

getRequestQueue

public RequestQueue getRequestQueue()

The broker global request queue.

Returns:

the global request queue

getTrackingUsers

public POPRemoteCaller[] getTrackingUsers()

All the currently tracked users.

Returns:

An array of callerID via Combox.getRemoteCaller() }

getTracked

public POPTracking getTracked(POPRemoteCaller caller)

Statistics on a single user.

Parameters:

caller - A caller remote location

Returns:

the tracking object of this method

isUPNPEnabled

public boolean isUPNPEnabled()

Returns true if UPNP is enabled

Returns: