org.openliberty.xmltooling.soapbinding
Enum UserInteraction.Interact

java.lang.Object
  java.lang.Enum<UserInteraction.Interact>
      org.openliberty.xmltooling.soapbinding.UserInteraction.Interact

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<UserInteraction.Interact>

Enclosing class:

UserInteraction

public static enum UserInteraction.Interact
extends java.lang.Enum<UserInteraction.Interact>

Implementors may choose to define additional values to indicate finer grained control over the user interactions.

Author:

asa

Enum Constant Summary

DO_NOT_INTERACT
Indicates to the recipient that it MUST NOT interact with the requesting principal, either directly or indirectly.

DO_NOT_INTERACT_FOR_DATA
Indicates to the recipient that it MAY interact with the requesting principal only if an explicit policy for the offered service so requires.

INTERACT_IF_NEEDED
Indicates to the recipient that it should interact with the requesting principal if needed to satisfy the ID-WSF request.

Field Summary

private java.lang.String

code

Method Summary

java.lang.String	getCode()
UserInteraction.Interact	getInteractForCode(java.lang.String code)
static UserInteraction.Interact	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static UserInteraction.Interact[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INTERACT_IF_NEEDED

public static final UserInteraction.Interact INTERACT_IF_NEEDED

Indicates to the recipient that it should interact with the requesting principal if needed to satisfy the ID-WSF request. This is the default.

DO_NOT_INTERACT

public static final UserInteraction.Interact DO_NOT_INTERACT

Indicates to the recipient that it MUST NOT interact with the requesting principal, either directly or indirectly. The sender prefers to receive an error response over the situation where the requesting principal would be distracted by an interaction.

DO_NOT_INTERACT_FOR_DATA

public static final UserInteraction.Interact DO_NOT_INTERACT_FOR_DATA

Indicates to the recipient that it MAY interact with the requesting principal only if an explicit policy for the offered service so requires. The sender prefers to receive an error response over the situation where the WSP would obtain service response data (e.g. Personal Profile data) from the resource owner, but the sender does prefer to obtain a positive service response even if that requires policy-related interaction for e.g. obtaining consent.

Field Detail

code

private java.lang.String code

Method Detail

values

public static final UserInteraction.Interact[] values()

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:

for(UserInteraction.Interact c : UserInteraction.Interact.values())
        System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they're declared

valueOf

public static UserInteraction.Interact valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

getInteractForCode

public UserInteraction.Interact getInteractForCode(java.lang.String code)

getCode

public java.lang.String getCode()