uk.org.retep.util.messaging.Component Maven / Gradle / Ivy
/*
* Copyright (c) 1998-2009, Peter T Mount
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
*
* - Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* - Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* - Neither the name of the retep.org.uk nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
*
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
* OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package uk.org.retep.util.messaging;
/**
* Interface used to attach a component to a Router. Component's are attached to
* a Router and receive messages from it.
*
* @param Type of the address
* @param Type of the message defaulting to uk.org.retep.util.messaging.Message
* @author peter
* @since 9.2
*/
public interface Component>
{
/**
* The Key associated with this component or null if not defined
* @return
*/
K getKey();
/**
* Consume a message that this component accepts
* @param message Message to consume
* @throws MessageException
*/
void consume( M message )
throws MessageException;
/**
* Used by a Router when attaching the Component, sets the MessagingService
* allowing the component to be able to send messages back to the system.
* @param messagingService MessagingService
* @throws MessageException if the component is already attached
*/
void setMessagingService( MessagingService messagingService )
throws MessageException;
/**
* Lifecycle method. This will be called when the router starts, or if already
* started just after it is attached.
*
*
* By contract a subclass must call super.startComponent() at the start of it's
* implementation.
*
*
* @throws uk.org.retep.util.messaging.MessageException
*/
void startComponent()
throws MessageException;
/**
* Lifecycle method. This will be called when the router stop's, or just before
* it is detatched from a router.
*
*
* By contract a subclass must call super.stopComponent() at the end of it's
* implementation.
*
*/
void stopComponent();
/**
* Has this component been started
* @return true if the component has been started
*/
boolean isComponentStarted();
}