Package de.xima.fc.security.endpoint

Enum EIncludesEndpoint

java.lang.Object

java.lang.Enum<EIncludesEndpoint>

de.xima.fc.security.endpoint.EIncludesEndpoint

All Implemented Interfaces:

IWebEndpoint, Serializable, Comparable<EIncludesEndpoint>

public enum EIncludesEndpoint
extends Enum<EIncludesEndpoint>
implements IWebEndpoint

Default definitions for includes web endpoints.

Since:

8.0.0

Author:

XIMA Media GmbH

Enum Constant Summary

Enum Constants

Enum Constant	Description
DOWNLOAD_INCLUDES
DOWNLOAD_INCLUDES_DEV

Method Summary

Modifier and Type	Method	Description
IAuthorizer	getAuthorizer()
IAvailabiltyResolver	getAvailibilityResolver()
@NotEmpty String	getId()
@NotNull IUriResolver	getUriResolver()
String	toString()
static EIncludesEndpoint	valueOf(String name)	Returns the enum constant of this type with the specified name.
static EIncludesEndpoint[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DOWNLOAD_INCLUDES

public static final EIncludesEndpoint DOWNLOAD_INCLUDES

DOWNLOAD_INCLUDES_DEV

public static final EIncludesEndpoint DOWNLOAD_INCLUDES_DEV

Method Detail

values

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

Returns:

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

valueOf

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

getId

@NotEmpty
public @NotEmpty String getId()

Specified by:

getId in interface IWebEndpoint

Returns:

the unique ID of this web endpoint.

getUriResolver

@NotNull
public @NotNull IUriResolver getUriResolver()

Specified by:

getUriResolver in interface IWebEndpoint

Returns:

the uri resolver which defines the location of this endpoint.

getAvailibilityResolver

public IAvailabiltyResolver getAvailibilityResolver()

Specified by:

getAvailibilityResolver in interface IWebEndpoint

Returns:

the availability resolver that defines the availability requirements of this web endpoint. May be null. If null resolver is returned than the web endpoint is available.

getAuthorizer

public IAuthorizer getAuthorizer()

Specified by:

getAuthorizer in interface IWebEndpoint

Returns:

the authorizer that defines authorization requirements of this web endpoint. May be null. If null authorizer is returned than the view web enpoint is public, which means any user can access it.

toString

public String toString()

Overrides:

toString in class Enum<EIncludesEndpoint>