|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object PIRL.Messenger.Dispatcher PIRL.Conductor.Maestro.Stage_Manager
public class Stage_Manager
A Stage_Manager is a Messenger manager for communication between Conductor processes and client processes.
Theater
,
Messenger
Field Summary | |
---|---|
static String |
ASSISTANT_NAME
|
static String |
COMMAND_PARAMETER_NAME
|
static String |
CONDUCTOR_COMMAND_PARAMETER_NAME
The name of the Configuration parameter that specifies the Conductor command name. |
static String |
COUNT_PARAMETER_NAME
|
static int |
DEFAULT_MAX_START_CONDUCTORS_COUNT
The default maximum number of remote Conductor commands that may be executed by a single request. |
static String |
EXCEPTION_PARAMETER_NAME
|
static String |
EXPLANATION_PARAMETER_NAME
|
static String |
ID
Class identification name with source code version and date. |
static String |
MAX_START_CONDUCTORS_COUNT_PARAMETER_NAME
The name of the Configuration parameter that specifies the maximum number of remote Conductor commands that may be executed by a single request. |
static String |
REPORT_PARAMETER_NAME
|
static String |
STAGE_MANAGER_NAME
The name used by the base Dispatcher class for the Stage_Manager service. |
static String |
START_CONDUCTORS_ACTION
|
Constructor Summary | |
---|---|
Stage_Manager()
Construct a Stage_Manager. |
|
Stage_Manager(Configuration configuration)
Construct a Stage_Manager using a Configuration. |
|
Stage_Manager(Configuration configuration,
int port)
Construct a Stage_Manager using a Configuration and port number. |
Method Summary | |
---|---|
protected void |
Configure(Configuration configuration)
Configures the Stage_Manager. |
static void |
main(String[] args)
|
void |
Message_Delivered(Message_Delivered_Event event)
Receives delivery of a message. |
static void |
Usage()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String ID
public static final String STAGE_MANAGER_NAME
Dispatcher.Dispatcher_Name(String)
,
Constant Field Valuespublic static final String CONDUCTOR_COMMAND_PARAMETER_NAME
If this parameter is not present or its value is empty or "disabled" remote Conductor command execution is disabled.
public static final String MAX_START_CONDUCTORS_COUNT_PARAMETER_NAME
If the Count of remote commands exceeds this value no commands will be executed and an exception response will be sent in reply.
CONDUCTOR_COMMAND_PARAMETER_NAME
,
Constant Field Valuespublic static final int DEFAULT_MAX_START_CONDUCTORS_COUNT
MAX_START_CONDUCTORS_COUNT_PARAMETER_NAME
,
Constant Field Valuespublic static final String START_CONDUCTORS_ACTION
public static final String COUNT_PARAMETER_NAME
public static final String EXPLANATION_PARAMETER_NAME
public static final String COMMAND_PARAMETER_NAME
public static final String REPORT_PARAMETER_NAME
public static final String EXCEPTION_PARAMETER_NAME
public static final String ASSISTANT_NAME
Constructor Detail |
---|
public Stage_Manager(Configuration configuration, int port)
The base Dispatcher
class is constructed using the
STAGE_MANAGER_NAME
along with the specified Configuration
and port number. The Dispatcher.Dispatcher_ID
is set to the
ID
of this class.
configuration
- A Configuration. If null an attempt will
be made to use a default configuration source.port
- The communications port number. If less than or equal
to zero a Dispatcher.DEFAULT_PORT
number will be used.public Stage_Manager(Configuration configuration)
The base Dispatcher class will provide a default communications port number.
configuration
- A Configuration. If null an attempt will
be made to use a default configuration source.Stage_Manager(Configuration, int)
public Stage_Manager()
Defaults will be provided for the Configuration source and communications port number.
Stage_Manager(Configuration, int)
Method Detail |
---|
protected void Configure(Configuration configuration) throws Configuration_Exception, SecurityException
The Configuration class is set to use this class when using a class-relative search for a configuration source when a Configuration is not provided.
The base Dispatcher class is configured
and then Stage_Manager specific parameters are obtained.
CONDUCTOR_COMMAND_PARAMETER_NAME
MAX_START_CONDUCTORS_COUNT_PARAMETER_NAME
DEFAULT_MAX_START_CONDUCTORS_COUNT
; the minimum value is 1.
N.B.: All parameters are sought in the in the Configuration Group
with the Stage_Manager name
.
Configure
in class Dispatcher
configuration
- The Configuration to use. If null and
defatult configuration source will sought.
Configuration_Exception
- If there was a problem parsing the
configuration source, accessing its contents, or establishing
a log file.
SecurityException
- If the connection authentication keys
could not be generated, no Dispatcher.PASSWORD_PARAMETER_NAME
was
found but Dispatcher.UNAUTHENTICATED_CONNECTIONS_ALLOWED
is false, or a log file could not be opened due to a security
violation.public void Message_Delivered(Message_Delivered_Event event)
Dispatcher
This method implements the Message_Delivered_Listener
interface.
The following message actions
are recognized:
Dispatcher.IDENTIFY_ACTION
identity Message
.
Dispatcher.MESSENGERS_REPORT_ACTION
currently connected messenger identities
that have been
selected by the request message.
Dispatcher.START_MESSENGER_REPORTING_ACTION
Starts connected
Messenger reporting
for the requesting Messenger.
Dispatcher.STOP_MESSENGER_REPORTING_ACTION
Stops connected
Messenger reporting
for the requesting Messenger.
Dispatcher.LINK_MESSENGER_ACTION
Dispatcher.Messenger_Link(Messenger, Message)
Messenger-to-Messenger communication} is established between the
requesting Messenger and another Messenger for which an address
is provided.
Dispatcher.UNLINK_MESSENGER_ACTION
Dispatcher.Messenger_Unlink(Messenger, Message)
Messenger-to-Messenger communication} is removed between the
requesting Messenger and another Messenger for which an address
is provided.
Dispatcher.DONE_ACTION
quit
and is to be
disconnected.
Dispatcher.UNDELIVERABLE_ACTION
sent
could
not be delivered. The undeliverable Message is logged.
Dispatcher.NACK_ACTION
sent
was
rejected. The rejected Message is logged.
Any other messages are logged as unrecognized and a NACK
is sent back to the Messenger from
which the message was received.
Message_Delivered
in interface Message_Delivered_Listener
Message_Delivered
in class Dispatcher
event
- The Message_Delivered_Event
containing the
Message that was delivered and a reference to the Messenger that
sent it.public static void main(String[] args)
public static void Usage()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |