org.objectweb.joram.shared.admin
Class AdminReply

java.lang.Object
  extended by org.objectweb.joram.shared.admin.AbstractAdminMessage
      extended by org.objectweb.joram.shared.admin.AdminReply
All Implemented Interfaces:
Streamable, java.io.Externalizable, java.io.Serializable
Direct Known Subclasses:
CreateDestinationReply, CreateUserReply, GetClusterReply, GetDestinationsReply, GetDMQSettingsReply, GetDomainNamesRep, GetFatherReply, GetLocalServerRep, GetNumberReply, GetQueueMessageIdsRep, GetQueueMessageRep, GetRightsReply, GetServersIdsReply, GetStatsReply, GetSubscriberIdsRep, GetSubscriptionMessageIdsRep, GetSubscriptionMessageRep, GetSubscriptionRep, GetSubscriptionsRep, GetUsersReply

public class AdminReply
extends AbstractAdminMessage

An AdminReply is a reply sent by a org.objectweb.joram.mom.dest.AdminTopic topic and containing data or information destinated to a client administrator.

See Also:
Serialized Form

Field Summary
static int BAD_CLUSTER_REQUEST
           
private  int errorCode
          Code d'erreur
private  java.lang.String info
          Information.
static int NAME_ALREADY_USED
           
static int NAME_UNKNOWN
           
static int PERMISSION_DENIED
           
private  java.lang.Object replyObj
          Object.
private static long serialVersionUID
          Define serialVersionUID for interoperability.
static int SERVER_ID_ALREADY_USED
           
static int START_FAILURE
           
private  boolean success
          true if this reply replies to a successful request.
static int UNKNOWN_REQUEST
           
static int UNKNOWN_SERVER
           
 
Fields inherited from class org.objectweb.joram.shared.admin.AbstractAdminMessage
ABSTRACT_ADMIN_MESSAGE, ADD_DOMAIN_REQUEST, ADD_QUEUE_CLUSTER, ADD_SERVER_REQUEST, ADD_SERVICE_REQUEST, ADMIN_REPLY, ADMIN_REQUEST, classid, classnames, CLEAR_QUEUE, CLEAR_SUBSCRIPTION, CREATE_DESTINATION_REPLY, CREATE_DESTINATION_REQUEST, CREATE_USER_REPLY, CREATE_USER_REQUEST, DELETE_DESTINATION, DELETE_QUEUE_MESSAGE, DELETE_SUBSCRIPTION_MESSAGE, DELETE_USER, GET_CONFIG_REQUEST, GET_DOMAIN_NAMES, GET_DOMAIN_NAMES_REP, GET_LOCAL_SERVER, GET_LOCAL_SERVER_REP, GET_QUEUE_MESSAGE, GET_QUEUE_MESSAGE_IDS, GET_QUEUE_MESSAGE_IDS_REP, GET_QUEUE_MESSAGE_REP, GET_RIGHTS_REPLY, GET_RIGHTS_REQUEST, GET_SUBSCRIBER_IDS, GET_SUBSCRIBER_IDS_REP, GET_SUBSCRIPTION, GET_SUBSCRIPTION_MESSAGE, GET_SUBSCRIPTION_MESSAGE_IDS, GET_SUBSCRIPTION_MESSAGE_IDS_REP, GET_SUBSCRIPTION_MESSAGE_REP, GET_SUBSCRIPTION_REP, GET_SUBSCRIPTIONS, GET_SUBSCRIPTIONS_REP, GET_USERS_REPLY, GET_USERS_REQUEST, LIST_CLUSTER_QUEUE, logger, MONITOR_GET_CLUSTER, MONITOR_GET_CLUSTER_REP, MONITOR_GET_DESTINATIONS, MONITOR_GET_DESTINATIONS_REP, MONITOR_GET_DMQ_SETTINGS, MONITOR_GET_DMQ_SETTINGS_REP, MONITOR_GET_FATHER, MONITOR_GET_FATHER_REP, MONITOR_GET_NB_MAX_MSG, MONITOR_GET_NUMBER_REP, MONITOR_GET_PENDING_MESSAGES, MONITOR_GET_PENDING_REQUESTS, MONITOR_GET_SERVERS_IDS, MONITOR_GET_SERVERS_IDS_REP, MONITOR_GET_STAT, MONITOR_GET_STAT_REP, MONITOR_GET_SUBSCRIPTIONS, MONITOR_REPLY, MONITOR_REQUEST, NULL_CLASS_ID, QUEUE_ADMIN_REQUEST, REMOVE_DOMAIN_REQUEST, REMOVE_QUEUE_CLUSTER, REMOVE_SERVER_REQUEST, REMOVE_SERVICE_REQUEST, SET_CLUSTER, SET_DMQ, SET_FATHER, SET_NB_MAX_MSG, SET_READER, SET_RIGHT, SET_THRESHOLD, SET_WRITER, SPECIAL_ADMIN, STOP_SERVER_REQUEST, SUBSCRIPTION_ADMIN_REQUEST, UNSET_READER, UNSET_WRITER, UPDATE_USER, USER_ADMIN_REQUEST, XXX_MONITOR_GET_NB_MAX_MSG_REP, XXX_MONITOR_GET_READERS, XXX_MONITOR_GET_WRITERS, XXX_SET_DEFAULT_DMQ, XXX_SET_QUEUE_THRESHOLD, XXX_SET_USER_DMQ, XXX_SET_USER_THRESHOLD, XXX_UNSET_CLUSTER, XXX_UNSET_DEFAULT_DMQ, XXX_UNSET_DEFAULT_THRESHOLD, XXX_UNSET_DESTINATION_DMQ, XXX_UNSET_FATHER, XXX_UNSET_QUEUE_THRESHOLD, XXX_UNSET_USER_DMQ, XXX_UNSET_USER_THRESHOLD
 
Constructor Summary
AdminReply()
           
AdminReply(boolean success, java.lang.String info)
          Constructs an AdminReply instance.
AdminReply(boolean success, java.lang.String info, java.lang.Object replyObj)
          Constructs an AdminReply instance.
AdminReply(int errorCode, java.lang.String info)
          Constructs an AdminReply instance for simple error cases.
 
Method Summary
protected  int getClassId()
           
 int getErrorCode()
          Returns the error code.
 java.lang.String getInfo()
          Returns the carried info.
 java.lang.Object getReplyObject()
          Returns the carried object.
 void readFrom(java.io.InputStream is)
          The object implements the readFrom method to restore its contents from the input stream.
 boolean succeeded()
          Returns true if this reply replies to a successful request.
 java.lang.String toString()
           
 void writeTo(java.io.OutputStream os)
          The object implements the writeTo method to write its contents to the output stream.
 
Methods inherited from class org.objectweb.joram.shared.admin.AbstractAdminMessage
read, readExternal, soapCode, soapDecode, write, writeExternal
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

serialVersionUID

private static final long serialVersionUID
Define serialVersionUID for interoperability.

See Also:
Constant Field Values

NAME_ALREADY_USED

public static final int NAME_ALREADY_USED
See Also:
Constant Field Values

START_FAILURE

public static final int START_FAILURE
See Also:
Constant Field Values

SERVER_ID_ALREADY_USED

public static final int SERVER_ID_ALREADY_USED
See Also:
Constant Field Values

UNKNOWN_SERVER

public static final int UNKNOWN_SERVER
See Also:
Constant Field Values

PERMISSION_DENIED

public static final int PERMISSION_DENIED
See Also:
Constant Field Values

UNKNOWN_REQUEST

public static final int UNKNOWN_REQUEST
See Also:
Constant Field Values

NAME_UNKNOWN

public static final int NAME_UNKNOWN
See Also:
Constant Field Values

BAD_CLUSTER_REQUEST

public static final int BAD_CLUSTER_REQUEST
See Also:
Constant Field Values

success

private boolean success
true if this reply replies to a successful request.


info

private java.lang.String info
Information.


replyObj

private java.lang.Object replyObj
Object.


errorCode

private int errorCode
Code d'erreur

Constructor Detail

AdminReply

public AdminReply(boolean success,
                  java.lang.String info)
Constructs an AdminReply instance.

Parameters:
success - true if this reply replies to a successful request.
info - Information to carry.

AdminReply

public AdminReply(boolean success,
                  java.lang.String info,
                  java.lang.Object replyObj)
Constructs an AdminReply instance.

Parameters:
success - true if this reply replies to a successful request.
info - Information to carry.
replyObj - Object to carry.

AdminReply

public AdminReply(int errorCode,
                  java.lang.String info)
Constructs an AdminReply instance for simple error cases.

Parameters:
success - true if this reply replies to a successful request.
errorCode - error code defining the type of the error
info - Information to carry.
replyObj - Object to carry.

AdminReply

public AdminReply()
Method Detail

succeeded

public final boolean succeeded()
Returns true if this reply replies to a successful request.


getInfo

public final java.lang.String getInfo()
Returns the carried info.


getReplyObject

public final java.lang.Object getReplyObject()
Returns the carried object.


getErrorCode

public final int getErrorCode()
Returns the error code.


toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

getClassId

protected int getClassId()
Specified by:
getClassId in class AbstractAdminMessage

writeTo

public void writeTo(java.io.OutputStream os)
             throws java.io.IOException
Description copied from interface: Streamable
The object implements the writeTo method to write its contents to the output stream.

Parameters:
os - the stream to write the object to
Throws:
java.io.IOException

readFrom

public void readFrom(java.io.InputStream is)
              throws java.io.IOException
Description copied from interface: Streamable
The object implements the readFrom method to restore its contents from the input stream.

Parameters:
is - the stream to read data from in order to restore the object
Throws:
java.io.IOException


Copyright © 2010 ScalAgent D.T.. All Rights Reserved.