org.fcrepo.server.messaging

Class MessagingModule

java.lang.Object

org.fcrepo.server.Parameterized

org.fcrepo.server.Pluggable

org.fcrepo.server.Module

org.fcrepo.server.messaging.MessagingModule

All Implemented Interfaces:

Constants, Messaging

public class MessagingModule
extends Module
implements Messaging

Fedora's Messaging as a configurable module.

Version:

$Id$

Author:

Edwin Shin

Nested Class Summary

Nested classes/interfaces inherited from interface org.fcrepo.server.messaging.Messaging

Messaging.MessageType

Nested classes/interfaces inherited from interface org.fcrepo.common.Constants

Constants.FedoraHome

Field Summary

Fields inherited from interface org.fcrepo.common.Constants

ACCESS, ACTION, API, ATOM_APIM1_0, ATOM_ZIP1_1, ATOM1_1, AUDIT, AUDIT1_0, BATCH_MODIFY, BATCH_MODIFY1_1, BE_SECURITY, BE_SECURITY1_0, BINDING_SPEC, DATASTREAM, DC, DISSEMINATOR, DS_COMPOSITE_MODEL, DS_COMPOSITE_MODEL1_0, DS_INPUT_SPEC1_0, DS_INPUT_SPEC1_1, ENVIRONMENT, FCFG, FEDORA, FEDORA_APP_CONTEXT_NAME, FEDORA_DEFAULT_APP_CONTEXT, FEDORA_HOME, FEDORA_REPOSITORY_PID, FOXML, FOXML1_0, FOXML1_0_LEGACY, FOXML1_1, HTTP_REQUEST, MANAGEMENT, METHOD_MAP, METS, METS_EXT, METS_EXT1_0, METS_EXT1_0_LEGACY, METS_EXT1_1, MODEL, MULGARA, OAI_DC, OAI_DC2_0, OAI_FRIENDS, OAI_FRIENDS2_0, OAI_IDENTIFIER, OAI_IDENTIFIER2_0, OAI_PMH, OAI_PMH2_0, OAI_PROV, OAI_PROV2_0, OBJ_DATASTREAMS1_0, OBJ_HISTORY1_0, OBJ_ITEMS1_0, OBJ_METHODS1_0, OBJ_PROFILE1_0, OBJ_VALIDATION1_0, OBJECT, OLD_XLINK, PID_LIST1_0, RDF, RDF_XSD, RECOVERY, RELS_EXT, RELS_EXT1_0, RELS_INT1_0, REPO_DESC1_0, RESOURCE, SDEF, SDEF_METHOD_MAP1_0, SDEP, SDEP_METHOD_MAP1_0, SDEP_METHOD_MAP1_1, SERVICE_PROFILE, SOAP, SOAP_ENC, SUBJECT, TYPES, VIEW, WSDL, WSDL_HTTP, WSDL_MIME, XACML_POLICY, XACML_POLICY1_0, XACML1, XACML1_ACTION, XACML1_POLICY, XACML1_RESOURCE, XACML1_SUBJECT, XACML2_POLICY_SCHEMA, XLINK, XML_XSD, XMLNS, XSI

Constructor Summary

Constructors

Constructor and Description
MessagingModule(Map<String,String> moduleParameters, Server server, String role)

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Shutdown and/or close any resources and/or connections.
void	initModule() Initializes the Module based on configuration parameters.
void	postInitModule() Second stage of Module initialization.
void	send(FedoraMethod method) Send a message representing the FedoraMethod.
void	send(String destName, FedoraMessage message) Send the FedoraMessage to the specified destination.
void	shutdownModule() Frees system resources allocated by this Module.

Methods inherited from class org.fcrepo.server.Module

getRole, getServer

Methods inherited from class org.fcrepo.server.Pluggable

getHelp, getOptionalParameters, getParameterHelp, getRequiredModuleRoles, getRequiredParameters

Methods inherited from class org.fcrepo.server.Parameterized

getParameter, getParameter, getParameter, getParameterList, getParameters, getParameters, parameterNames, setParameter, setParameters, setParameters

Methods inherited from class java.lang.Object

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

Constructor Detail

MessagingModule

public MessagingModule(Map<String,String> moduleParameters,
               Server server,
               String role)
                throws ModuleInitializationException

Throws:

ModuleInitializationException

Method Detail

initModule

public void initModule()
                throws ModuleInitializationException

Description copied from class: Module

Initializes the Module based on configuration parameters.

Overrides:

initModule in class Module

Throws:

ModuleInitializationException - If initialization values are invalid or initialization fails for some other reason.

postInitModule

public void postInitModule()
                    throws ModuleInitializationException

Description copied from class: Module

Second stage of Module initialization. This is guaranteed to run after all Modules' initModule() methods have run.

Overrides:

postInitModule in class Module

Throws:

ModuleInitializationException - If initialization values are invalid or initialization fails for some other reason.

shutdownModule

public void shutdownModule()
                    throws ModuleShutdownException

Description copied from class: Module

Frees system resources allocated by this Module.

Overrides:

shutdownModule in class Module

Throws:

ModuleShutdownException - If there is a problem freeing system resources. Note that if there is a problem, it won't end up aborting the shutdown process. Therefore, this method should do everything possible to recover from exceptional situations before throwing an exception.

send

public void send(String destName,
        FedoraMessage message)
          throws MessagingException

Description copied from interface: Messaging

Send the FedoraMessage to the specified destination.

Specified by:

send in interface Messaging

Parameters:

destName - The destination of the message.

message - The message to send.

Throws:

MessagingException

send

public void send(FedoraMethod method)
          throws MessagingException

Description copied from interface: Messaging

Send a message representing the FedoraMethod. The message representation and destination(s) are determined by the implementing class.

Specified by:

send in interface Messaging

Parameters:

method - The method to send.

Throws:

MessagingException

close

public void close()
           throws MessagingException

Description copied from interface: Messaging

Shutdown and/or close any resources and/or connections.

Specified by:

close in interface Messaging

Throws:

MessagingException