org.csapi.jr.se.pam.provisioning
Interface PAMAgentAssignment

All Superinterfaces:
CsapiInterface, java.io.Serializable, Service

public interface PAMAgentAssignment
extends Service

This interface represents a PAMAgentAssignment.


Field Summary
 
Fields inherited from interface org.csapi.jr.se.Service
IN_SERVICE_STATE, OUT_OF_SERVICE_STATE
 
Method Summary
 void assignAgent(java.lang.String identity, java.lang.String agentName, byte[] authToken)
          Invokes the assignAgent() method on the Parlay Gateway.
 boolean isIdentityCapableOf(java.lang.String identity, java.lang.String capability, byte[] authToken)
          Invokes the isIdentityCapableOf() method on the Parlay Gateway.
 java.lang.String[] listAssignedAgents(java.lang.String identity, byte[] authToken)
          Invokes the listAssignedAgents() method on the Parlay Gateway.
 java.lang.String[] listAssignedAgentsByCapability(java.lang.String identity, java.lang.String capability, byte[] authToken)
          Invokes the listAssignedAgentsByCapability() method on the Parlay Gateway.
 java.lang.String[] listAssociatedIdentitiesOfAgent(java.lang.String agentName, byte[] authToken)
          Invokes the listAssociatedIdentitiesOfAgent() method on the Parlay Gateway.
 java.lang.String[] listCapabilitiesOfIdentity(java.lang.String identity, byte[] authToken)
          Invokes the listCapabilitiesOfIdentity() method on the Parlay Gateway.
 void unassignAgent(java.lang.String identity, java.lang.String agentName, byte[] authToken)
          Invokes the unassignAgent() method on the Parlay Gateway.
 
Methods inherited from interface org.csapi.jr.se.Service
addServiceStateChangeListener, getServiceState, removeServiceStateChangeListener, setCallback
 

Method Detail

assignAgent

public void assignAgent(java.lang.String identity,
                        java.lang.String agentName,
                        byte[] authToken)
                 throws PlatformException,
                        CommonException,
                        PamUnknownIdentityException,
                        PamUnknownAgentException,
                        PamInvalidCredentialException
Invokes the assignAgent() method on the Parlay Gateway.

PlatformException
CommonException
PamUnknownIdentityException
PamUnknownAgentException
PamInvalidCredentialException

unassignAgent

public void unassignAgent(java.lang.String identity,
                          java.lang.String agentName,
                          byte[] authToken)
                   throws PlatformException,
                          CommonException,
                          PamUnknownIdentityException,
                          PamUnknownAgentException,
                          PamUnknownAssignmentException,
                          PamInvalidCredentialException
Invokes the unassignAgent() method on the Parlay Gateway.

PlatformException
CommonException
PamUnknownIdentityException
PamUnknownAgentException
PamUnknownAssignmentException
PamInvalidCredentialException

listAssignedAgents

public java.lang.String[] listAssignedAgents(java.lang.String identity,
                                             byte[] authToken)
                                      throws PlatformException,
                                             CommonException,
                                             PamUnknownIdentityException,
                                             PamInvalidCredentialException
Invokes the listAssignedAgents() method on the Parlay Gateway.

PlatformException
CommonException
PamUnknownIdentityException
PamInvalidCredentialException

listAssociatedIdentitiesOfAgent

public java.lang.String[] listAssociatedIdentitiesOfAgent(java.lang.String agentName,
                                                          byte[] authToken)
                                                   throws PlatformException,
                                                          CommonException,
                                                          PamUnknownAgentException,
                                                          PamInvalidCredentialException
Invokes the listAssociatedIdentitiesOfAgent() method on the Parlay Gateway.

PlatformException
CommonException
PamUnknownAgentException
PamInvalidCredentialException

listAssignedAgentsByCapability

public java.lang.String[] listAssignedAgentsByCapability(java.lang.String identity,
                                                         java.lang.String capability,
                                                         byte[] authToken)
                                                  throws PlatformException,
                                                         CommonException,
                                                         PamUnknownIdentityException,
                                                         PamInvalidCredentialException
Invokes the listAssignedAgentsByCapability() method on the Parlay Gateway.

PlatformException
CommonException
PamUnknownIdentityException
PamInvalidCredentialException

listCapabilitiesOfIdentity

public java.lang.String[] listCapabilitiesOfIdentity(java.lang.String identity,
                                                     byte[] authToken)
                                              throws PlatformException,
                                                     CommonException,
                                                     PamUnknownIdentityException,
                                                     PamInvalidCredentialException
Invokes the listCapabilitiesOfIdentity() method on the Parlay Gateway.

PlatformException
CommonException
PamUnknownIdentityException
PamInvalidCredentialException

isIdentityCapableOf

public boolean isIdentityCapableOf(java.lang.String identity,
                                   java.lang.String capability,
                                   byte[] authToken)
                            throws PlatformException,
                                   CommonException,
                                   PamUnknownIdentityException,
                                   PamInvalidCredentialException
Invokes the isIdentityCapableOf() method on the Parlay Gateway.

PlatformException
CommonException
PamUnknownIdentityException
PamInvalidCredentialException