org.wso2.mb.integration.common.clients.operations.clients

Class AndesAdminClient

java.lang.Object

org.wso2.mb.integration.common.clients.operations.clients.AndesAdminClient

public class AndesAdminClient
extends Object

Andes Admin Client is a client which is used to contact the Andes Admin services

Field Summary

Fields

Modifier and Type	Field and Description
static String	PUBLISHER_ROLE

Constructor Summary

Constructors

Constructor and Description
AndesAdminClient(String backendUrl, String sessionCookie) Initializes Andes Admin Client

Method Summary

Modifier and Type	Method and Description
org.wso2.carbon.andes.stub.admin.types.Message[]	browseQueue(String queue, int startingIndex, int maximumMessageCount) Gets messages in a queue
void	createQueue(String queue) Creates a new queue
void	deleteQueue(String queue) Deletes a queue
org.wso2.carbon.andes.stub.admin.types.Queue	getDlcQueue() Get dead letter channel queue
org.wso2.carbon.andes.stub.admin.types.Queue	getQueueByName(String name) Get queue object by queue name
void	purgeQueue(String queue) Deletes all messages in a queue
void	updatePermissionForQueue(String queueName, org.wso2.carbon.andes.stub.admin.types.QueueRolePermission permissions) Updating permissions for a queue.

Methods inherited from class java.lang.Object

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

Field Detail

PUBLISHER_ROLE

public static final String PUBLISHER_ROLE

See Also:

Constant Field Values

Constructor Detail

AndesAdminClient

public AndesAdminClient(String backendUrl,
                        String sessionCookie)
                 throws org.apache.axis2.AxisFault

Initializes Andes Admin Client

Parameters:

backendUrl - the backend url

sessionCookie - the session cookie string

Throws:

org.apache.axis2.AxisFault

Method Detail

createQueue

public void createQueue(String queue)
                 throws org.wso2.carbon.andes.stub.AndesAdminServiceBrokerManagerAdminException,
                        RemoteException

Creates a new queue

Parameters:

queue - new queue name

Throws:

org.wso2.carbon.andes.stub.AndesAdminServiceBrokerManagerAdminException

RemoteException

browseQueue

public org.wso2.carbon.andes.stub.admin.types.Message[] browseQueue(String queue,
                                                                    int startingIndex,
                                                                    int maximumMessageCount)
                                                             throws org.wso2.carbon.andes.stub.AndesAdminServiceBrokerManagerAdminException,
                                                                    RemoteException

Gets messages in a queue

Parameters:

queue - the queue name

startingIndex - starting index of the messages to be returned

maximumMessageCount - maximum number of messages to return

Returns:

an array of messages

Throws:

org.wso2.carbon.andes.stub.AndesAdminServiceBrokerManagerAdminException

RemoteException

deleteQueue

public void deleteQueue(String queue)
                 throws org.wso2.carbon.andes.stub.AndesAdminServiceBrokerManagerAdminException,
                        RemoteException

Deletes a queue

Parameters:

queue - the queue name

Throws:

org.wso2.carbon.andes.stub.AndesAdminServiceBrokerManagerAdminException

RemoteException

purgeQueue

public void purgeQueue(String queue)
                throws RemoteException,
                       org.wso2.carbon.andes.stub.AndesAdminServiceBrokerManagerAdminException

Deletes all messages in a queue

Parameters:

queue - the name of the queue

Throws:

RemoteException

org.wso2.carbon.andes.stub.AndesAdminServiceBrokerManagerAdminException

getQueueByName

public org.wso2.carbon.andes.stub.admin.types.Queue getQueueByName(String name)
                                                            throws RemoteException,
                                                                   org.wso2.carbon.andes.stub.AndesAdminServiceBrokerManagerAdminException

Get queue object by queue name

Parameters:

name - the name of the queue

Returns:

a queue

Throws:

RemoteException

org.wso2.carbon.andes.stub.AndesAdminServiceBrokerManagerAdminException

updatePermissionForQueue

public void updatePermissionForQueue(String queueName,
                                     org.wso2.carbon.andes.stub.admin.types.QueueRolePermission permissions)
                              throws org.wso2.carbon.andes.stub.AndesAdminServiceBrokerManagerAdminException,
                                     RemoteException

Updating permissions for a queue. Permissions may include publish, consume etc

Parameters:

queueName - queue name

permissions - new permissions

Throws:

org.wso2.carbon.andes.stub.AndesAdminServiceBrokerManagerAdminException

RemoteException

getDlcQueue

public org.wso2.carbon.andes.stub.admin.types.Queue getDlcQueue()
                                                         throws org.wso2.carbon.andes.stub.AndesAdminServiceBrokerManagerAdminException,
                                                                RemoteException

Get dead letter channel queue

Returns:

queue

Throws:

org.wso2.carbon.andes.stub.AndesAdminServiceBrokerManagerAdminException

RemoteException