org.jasig.cas.client
Enum Protocol

java.lang.Object
  java.lang.Enum<Protocol>
      org.jasig.cas.client.Protocol

All Implemented Interfaces:

Serializable, Comparable<Protocol>

public enum Protocol
extends Enum<Protocol>

Simple enumeration to hold/capture some of the standard request parameters used by the various protocols.

Since:

3.4.0

Author:

Scott Battaglia

Enum Constant Summary

CAS1

CAS2

CAS3

SAML11

Method Summary

String	getArtifactParameterName()
String	getServiceParameterName()
static Protocol	valueOf(String name) Returns the enum constant of this type with the specified name.
static Protocol[]	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

CAS1

public static final Protocol CAS1

CAS2

public static final Protocol CAS2

CAS3

public static final Protocol CAS3

SAML11

public static final Protocol SAML11

Method Detail

values

public static Protocol[] 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 (Protocol c : Protocol.values())
    System.out.println(c);

Returns:

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

valueOf

public static Protocol 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

getArtifactParameterName

public String getArtifactParameterName()

getServiceParameterName

public String getServiceParameterName()