com.avaya.conferencing.api.acp.control.operations
Class OperatorLogin

java.lang.Object
  com.avaya.conferencing.api.acp.control.operations.AbstractOperationImpl<Operator,OperatorLogin>
      com.avaya.conferencing.api.acp.control.operations.OperatorLogin

All Implemented Interfaces:

Operation<Operator,OperatorLogin>, java.lang.Cloneable

public final class OperatorLogin
extends AbstractOperationImpl<Operator,OperatorLogin>

Login an Operator. The username and password fields must be supplied. After an Operator has connected, they may need to establish an EndPoint in order to interact with the other EndPoints on the Connection. There are two ways for an operator to establish an EndPoint:

• Performing a MakeCall on the Operator.
• Dialling into the URI Operator.getToURI().

The setToURI(String) method can be used to ensure that this Operation only returns an Operator with the property such that Operator.getToURI() == getToURI().

The operation will return the new Operator

Since:

5.1.0.0.29

Nested Class Summary

Nested classes/interfaces inherited from interface com.avaya.conferencing.api.acp.control.operations.Operation

Operation.Impact

Method Summary

Operation.Impact	getImpact() Returns the impact of the operation.
char[]	getPassword() Returns the password of this OperatorLogin object.
java.lang.String	getToURI() Returns the desired Operator.getToURI() of the Operator object returned by this OperatorLogin.
java.lang.String	getUsername() Returns the username of this OperatorLogin object.
Verb	getVerb() This gets the verb that describes this operation.
void	setPassword(char[] password) Sets the password of this OperatorLogin object.
void	setToURI(java.lang.String toURI) Sets the desired Operator.getToURI() of the Operator object returned by this OperatorLogin.
void	setUsername(java.lang.String username) Sets the username of this OperatorLogin object.

Methods inherited from class com.avaya.conferencing.api.acp.control.operations.AbstractOperationImpl

await, await, checkNotSubmitted, checkSubmitted, clone, get, get, isDone, isSubmitted, set, toString

Methods inherited from class java.lang.Object

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

Method Detail

getToURI

public java.lang.String getToURI()

Returns the desired Operator.getToURI() of the Operator object returned by this OperatorLogin.

Returns:

One of the following:

• The desired Operator.getToURI() of the Operator object returned by this OperatorLogin
• Either null or "" to accept any Operator.getToURI()
.
Since:
5.1.0.0.29

setToURI

public void setToURI(java.lang.String toURI)

Sets the desired Operator.getToURI() of the Operator object returned by this OperatorLogin. There are two ways for an operator to establish an EndPoint:

• Performing a MakeCall on the Operator.
• Dialling into the URI Operator.getToURI().

The setToURI(String) method can be used to ensure that this Operation only returns an Operator with the property that Operator.getToURI() == getToURI().

Parameters:

toURI - One of the following:

• The desired Operator.getToURI() of the Operator object returned by this OperatorLogin
• Either null or "" to accept any Operator.getToURI()
.
Since:
5.1.0.0.29

getUsername

public java.lang.String getUsername()

Returns the username of this OperatorLogin object.

Returns:

The username of this OperatorLogin object.

Since:

5.1.0.0.29

setUsername

@Required
public void setUsername(java.lang.String username)

Sets the username of this OperatorLogin object.

Parameters:

username - the username of this OperatorLogin object.

Since:

5.1.0.0.29

getImpact

public Operation.Impact getImpact()

Returns the impact of the operation.

Returns:

the impact.

Since:

5.1.0.0.29

getVerb

public Verb getVerb()

This gets the verb that describes this operation. Multiple operations may return the same verb, however verbs must be unique across the preferred operations. That is only one prefered operation may implement the "mute" verb. There may be deprecated operations that implement the "mute" verb but these will be less performant as they will be implemented as wrappers for the preferred "mute" operation.

Returns:

the verb that describes the operation.

Since:

5.1.0.0.29

getPassword

public char[] getPassword()

Returns the password of this OperatorLogin object.

Returns:

The password of this OperatorLogin object.

Since:

5.1.0.0.29

setPassword

@Required
public void setPassword(char[] password)

Sets the password of this OperatorLogin object.

Parameters:

password - the password of this OperatorLogin object.

Since:

5.1.0.0.29