KeyAgreementParameters.ActorType (Apache XML Security for Java 4.0.3 API)

java.lang.Object
- java.lang.Enum<KeyAgreementParameters.ActorType>
- - org.apache.xml.security.encryption.params.KeyAgreementParameters.ActorType

All Implemented Interfaces:

Serializable, Comparable<KeyAgreementParameters.ActorType>

Enclosing class:

KeyAgreementParameters
```
public static enum KeyAgreementParameters.ActorType
extends Enum<KeyAgreementParameters.ActorType>
```
This enum defines the actor type of the KeyAgreement algorithm. The actor type defines which public and which private key is expected to be present for the KeyAgreement algorithm to define derived key.
- ORIGINATOR: The key agreement is used by originator of the message. Therefore, the originator private key and the recipient public key are expected to be present.
- RECIPIENT: The key agreement is used by recipient of the message. Therefore, the recipient private key and the originator public key are expected to be present.

Enum Constant Summary

Enum Constants
Enum Constant Description

ORIGINATOR

RECIPIENT

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static KeyAgreementParameters.ActorType`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static KeyAgreementParameters.ActorType[]`	`values()`	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - ORIGINATOR
```
public static final KeyAgreementParameters.ActorType ORIGINATOR
```
  - RECIPIENT
```
public static final KeyAgreementParameters.ActorType RECIPIENT
```
- Method Detail
  - values
```
public static KeyAgreementParameters.ActorType[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
    for (KeyAgreementParameters.ActorType c : KeyAgreementParameters.ActorType.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static KeyAgreementParameters.ActorType valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null