org.apache.shindig.auth

Enum AuthenticationMode

java.lang.Object

java.lang.Enum<AuthenticationMode>

org.apache.shindig.auth.AuthenticationMode

All Implemented Interfaces:

Serializable, Comparable<AuthenticationMode>

public enum AuthenticationMode
extends Enum<AuthenticationMode>

Enumeration of known authentication modes

Enum Constant Summary

Enum Constants

Enum Constant and Description
COOKIE The request is from a logged in user of the receiving domain
OAUTH A fully validated 3-legged OAuth call by a 3rd party on behalf of a user of the receiving domain. viewerid should always be available
OAUTH_CONSUMER_REQUEST A call by a validated 3rd party on its own behalf.
SECURITY_TOKEN_URL_PARAMETER Used by rendered gadgets to authenticate calls to the container
UNAUTHENTICATED The request has no authentication associated with it.

Method Summary

Methods

Modifier and Type	Method and Description
static AuthenticationMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static AuthenticationMode[]	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

UNAUTHENTICATED

public static final AuthenticationMode UNAUTHENTICATED

The request has no authentication associated with it. Used for anonymous requests

SECURITY_TOKEN_URL_PARAMETER

public static final AuthenticationMode SECURITY_TOKEN_URL_PARAMETER

Used by rendered gadgets to authenticate calls to the container

OAUTH

public static final AuthenticationMode OAUTH

A fully validated 3-legged OAuth call by a 3rd party on behalf of a user of the receiving domain. viewerid should always be available

OAUTH_CONSUMER_REQUEST

public static final AuthenticationMode OAUTH_CONSUMER_REQUEST

A call by a validated 3rd party on its own behalf. Can emulate a call on behalf of a user of the receiving domain subject to ACL checking but is not required to do so. viewerid may or may not be available

COOKIE

public static final AuthenticationMode COOKIE

The request is from a logged in user of the receiving domain

Method Detail

values

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

Returns:

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

valueOf

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