Infinispan Distribution 5.2.6.Final-redhat-2

org.infinispan.xsite
Class XSiteAdminCommand

java.lang.Object
  extended by org.infinispan.commands.remote.BaseRpcCommand
      extended by org.infinispan.xsite.XSiteAdminCommand
All Implemented Interfaces:
CacheRpcCommand, ReplicableCommand

public class XSiteAdminCommand
extends BaseRpcCommand

Command used for handling XSiteReplication administrative operations.

Since:
5.2
Author:
Mircea Markus

Nested Class Summary
static class XSiteAdminCommand.AdminOperation
           
static class XSiteAdminCommand.Status
           
 
Field Summary
static int COMMAND_ID
           
 
Fields inherited from class org.infinispan.commands.remote.BaseRpcCommand
cacheName
 
Constructor Summary
XSiteAdminCommand()
           
XSiteAdminCommand(String cacheName)
           
XSiteAdminCommand(String cacheName, String siteName, XSiteAdminCommand.AdminOperation op, Integer afterFailures, Long minTimeToWait)
           
 
Method Summary
 byte getCommandId()
          Used by marshallers to convert this command into an id for streaming.
 Object[] getParameters()
          Used by marshallers to stream this command across a network
 void init(BackupSender backupSender)
           
 boolean isReturnValueExpected()
          If true, a return value will be provided when performed remotely.
 Object perform(InvocationContext ctx)
          Performs the primary function of the command.
 void setParameters(int commandId, Object[] parameters)
          Used by the CommandsFactory to create a command from raw data read off a stream.
 String toString()
           
 
Methods inherited from class org.infinispan.commands.remote.BaseRpcCommand
getCacheName, getOrigin, setOrigin
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

COMMAND_ID

public static final int COMMAND_ID
See Also:
Constant Field Values
Constructor Detail

XSiteAdminCommand

public XSiteAdminCommand()

XSiteAdminCommand

public XSiteAdminCommand(String cacheName)

XSiteAdminCommand

public XSiteAdminCommand(String cacheName,
                         String siteName,
                         XSiteAdminCommand.AdminOperation op,
                         Integer afterFailures,
                         Long minTimeToWait)
Method Detail

init

public void init(BackupSender backupSender)

perform

public Object perform(InvocationContext ctx)
               throws Throwable
Description copied from interface: ReplicableCommand
Performs the primary function of the command. Please see specific implementation classes for details on what is performed as well as return types. Important: this method will be invoked at the end of interceptors chain. It should never be called directly from a custom interceptor.

Parameters:
ctx - invocation context
Returns:
arbitrary return value generated by performing this command
Throws:
Throwable - in the event of problems.

getCommandId

public byte getCommandId()
Description copied from interface: ReplicableCommand
Used by marshallers to convert this command into an id for streaming.

Returns:
the method id of this command. This is compatible with pre-2.2.0 MethodCall ids.

getParameters

public Object[] getParameters()
Description copied from interface: ReplicableCommand
Used by marshallers to stream this command across a network

Returns:
an object array of arguments, compatible with pre-2.2.0 MethodCall args.

setParameters

public void setParameters(int commandId,
                          Object[] parameters)
Description copied from interface: ReplicableCommand
Used by the CommandsFactory to create a command from raw data read off a stream.

Parameters:
commandId - command id to set. This is usually unused but *could* be used in the event of a command having multiple IDs, such as PutKeyValueCommand.
parameters - object array of args

isReturnValueExpected

public final boolean isReturnValueExpected()
Description copied from interface: ReplicableCommand
If true, a return value will be provided when performed remotely. Otherwise, a remote ResponseGenerator may choose to simply return null to save on marshalling costs.

Returns:
true or false

toString

public String toString()
Overrides:
toString in class BaseRpcCommand

Infinispan Distribution 5.2.6.Final-redhat-2

Copyright © 2013 JBoss, a division of Red Hat. All Rights Reserved.