org.objectweb.joram.shared.admin.AdminReply Class Reference

Inherits org.objectweb.joram.shared.admin.AbstractAdminMessage.

Inherited by org.objectweb.joram.shared.admin.CreateDestinationReply, org.objectweb.joram.shared.admin.CreateUserReply, org.objectweb.joram.shared.admin.GetDomainNamesRep, org.objectweb.joram.shared.admin.GetLocalServerRep, org.objectweb.joram.shared.admin.GetQueueMessageIdsRep, org.objectweb.joram.shared.admin.GetQueueMessageRep, org.objectweb.joram.shared.admin.GetSubscriberIdsRep, org.objectweb.joram.shared.admin.GetSubscriptionMessageIdsRep, org.objectweb.joram.shared.admin.GetSubscriptionMessageRep, org.objectweb.joram.shared.admin.GetSubscriptionRep, org.objectweb.joram.shared.admin.GetSubscriptionsRep, and org.objectweb.joram.shared.admin.Monitor_Reply.

Inheritance diagram for org.objectweb.joram.shared.admin.AdminReply:

[legend]Collaboration diagram for org.objectweb.joram.shared.admin.AdminReply:

[legend]List of all members.

Public Member Functions
	AdminReply (boolean success, String info)
	AdminReply (boolean success, String info, Object replyObj)
	AdminReply (boolean success, int errorCode, String info, Object replyObj)
	AdminReply ()
final boolean	succeeded ()
final String	getInfo ()
final Object	getReplyObject ()
final int	getErrorCode ()
String	toString ()
void	writeTo (OutputStream os) throws IOException
void	readFrom (InputStream is) throws IOException
Static Public Attributes
static final int	NAME_ALREADY_USED = 0
static final int	START_FAILURE = 1
static final int	SERVER_ID_ALREADY_USED = 2
static final int	UNKNOWN_SERVER = 3
Protected Member Functions
int	getClassId ()

---

Detailed Description

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.

Definition at line 38 of file AdminReply.java.

---

Constructor & Destructor Documentation

org.objectweb.joram.shared.admin.AdminReply.AdminReply	(	boolean	success,
		String	info
	)

Constructs an AdminReply instance.

Parameters:

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

Definition at line 68 of file AdminReply.java.

org.objectweb.joram.shared.admin.AdminReply.AdminReply	(	boolean	success,
		String	info,
		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.

Definition at line 81 of file AdminReply.java.

org.objectweb.joram.shared.admin.AdminReply.AdminReply	(	boolean	success,
		int	errorCode,
		String	info,
		Object	replyObj
	)

Constructs an AdminReply instance.

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.

Definition at line 96 of file AdminReply.java.

---

Member Function Documentation

final boolean org.objectweb.joram.shared.admin.AdminReply.succeeded

(

)

Returns true if this reply replies to a successful request.

Definition at line 111 of file AdminReply.java.

Referenced by org.objectweb.joram.client.jms.admin.AdminModule.doRequest().

final String org.objectweb.joram.shared.admin.AdminReply.getInfo

(

)

Returns the carried info.

Definition at line 116 of file AdminReply.java.

Referenced by org.objectweb.joram.client.jms.admin.AdminModule.doRequest(), and org.objectweb.joram.client.jms.admin.AdminModule.getConfiguration().

final Object org.objectweb.joram.shared.admin.AdminReply.getReplyObject

(

)

Returns the carried object.

Definition at line 121 of file AdminReply.java.

Referenced by org.objectweb.joram.client.jms.Queue.getQueueClusterElements().

void org.objectweb.joram.shared.admin.AdminReply.writeTo

(

OutputStream

os

)

throws IOException

The object implements the writeTo method to write its contents to the output stream.

Parameters:

os

the stream to write the object to

Implements org.objectweb.joram.shared.stream.Streamable.

Reimplemented in org.objectweb.joram.shared.admin.CreateDestinationReply, org.objectweb.joram.shared.admin.CreateUserReply, org.objectweb.joram.shared.admin.GetDomainNamesRep, org.objectweb.joram.shared.admin.GetLocalServerRep, org.objectweb.joram.shared.admin.GetQueueMessageIdsRep, org.objectweb.joram.shared.admin.GetQueueMessageRep, org.objectweb.joram.shared.admin.GetSubscriberIdsRep, org.objectweb.joram.shared.admin.GetSubscriptionMessageIdsRep, org.objectweb.joram.shared.admin.GetSubscriptionMessageRep, org.objectweb.joram.shared.admin.GetSubscriptionRep, org.objectweb.joram.shared.admin.GetSubscriptionsRep, org.objectweb.joram.shared.admin.Monitor_GetClusterRep, org.objectweb.joram.shared.admin.Monitor_GetDestinationsRep, org.objectweb.joram.shared.admin.Monitor_GetDMQSettingsRep, org.objectweb.joram.shared.admin.Monitor_GetFatherRep, org.objectweb.joram.shared.admin.Monitor_GetFreeAccessRep, org.objectweb.joram.shared.admin.Monitor_GetNbMaxMsgRep, org.objectweb.joram.shared.admin.Monitor_GetNumberRep, org.objectweb.joram.shared.admin.Monitor_GetServersIdsRep, org.objectweb.joram.shared.admin.Monitor_GetStatRep, org.objectweb.joram.shared.admin.Monitor_GetUsersRep, and org.objectweb.joram.shared.admin.Monitor_Reply.

Definition at line 145 of file AdminReply.java.

void org.objectweb.joram.shared.admin.AdminReply.readFrom

(

InputStream

is

)

throws IOException

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

Implements org.objectweb.joram.shared.stream.Streamable.

Reimplemented in org.objectweb.joram.shared.admin.CreateDestinationReply, org.objectweb.joram.shared.admin.CreateUserReply, org.objectweb.joram.shared.admin.GetDomainNamesRep, org.objectweb.joram.shared.admin.GetLocalServerRep, org.objectweb.joram.shared.admin.GetQueueMessageIdsRep, org.objectweb.joram.shared.admin.GetQueueMessageRep, org.objectweb.joram.shared.admin.GetSubscriberIdsRep, org.objectweb.joram.shared.admin.GetSubscriptionMessageIdsRep, org.objectweb.joram.shared.admin.GetSubscriptionMessageRep, org.objectweb.joram.shared.admin.GetSubscriptionRep, org.objectweb.joram.shared.admin.GetSubscriptionsRep, org.objectweb.joram.shared.admin.Monitor_GetClusterRep, org.objectweb.joram.shared.admin.Monitor_GetDestinationsRep, org.objectweb.joram.shared.admin.Monitor_GetDMQSettingsRep, org.objectweb.joram.shared.admin.Monitor_GetFatherRep, org.objectweb.joram.shared.admin.Monitor_GetFreeAccessRep, org.objectweb.joram.shared.admin.Monitor_GetNbMaxMsgRep, org.objectweb.joram.shared.admin.Monitor_GetNumberRep, org.objectweb.joram.shared.admin.Monitor_GetServersIdsRep, org.objectweb.joram.shared.admin.Monitor_GetStatRep, org.objectweb.joram.shared.admin.Monitor_GetUsersRep, and org.objectweb.joram.shared.admin.Monitor_Reply.

Definition at line 152 of file AdminReply.java.

---

The documentation for this class was generated from the following file:

• org/objectweb/joram/shared/admin/AdminReply.java

---