Modifier and Type	Class and Description
public static enum	Constraint.Authorization The Authorization applied to any authentication of the request/
public static class	Constraint.Builder Builder for Constraint.
public static enum	Constraint.Transport The constraints requirement for the transport

Field Summary

Modifier and Type	Field and Description
public static final Constraint	ALLOWED A static Constraint that has `Authorization#ALLOWED` and `Transport#INHERIT`.
public static final Constraint	ALLOWED_ANY_TRANSPORT A static Constraint that has `Authorization#ALLOWED` and `Transport#ANY`.
public static final Constraint	ANY_TRANSPORT A static Constraint that has `Transport#ANY` and `Authorization#INHERIT`
public static final Constraint	ANY_USER A static Constraint that has `Authorization#ANY_USER` and `Transport#INHERIT`.
public static final Constraint	FORBIDDEN A static Constraint that has `Authorization#FORBIDDEN` and `Transport#INHERIT`.
public static final Constraint	KNOWN_ROLE A static Constraint that has `Authorization#KNOWN_ROLE` and `Transport#INHERIT`.
public static final Constraint	SECURE_TRANSPORT A static Constraint that has `Transport#SECURE` and `Authorization#INHERIT`

Method Summary

Modifier and Type	Method and Description
public static Constraint	Returns: the combined constraint. combine(Constraint Constraint to combine leastSpecific, Constraint Constraint to combine mostSpecific) Combine two Constraints by using `combine(String, Constraint, Constraint)` with a generated name.
public static Constraint	Returns: the combined constraint. combine(String The name to use for the combined constraint name, Constraint Constraint to combine leastSpecific, Constraint Constraint to combine mostSpecific) Combine two Constraints by: if both constraints are `Null`, then `Constraint#ALLOWED` is returned. if either constraint is `Null` the other is returned. only if the `mostSpecific` constraint has `Authorization#INHERIT` is the `leastSpecific` constraint's `Authorization` used, otherwise the `mostSpecific`'s is used. if the combined constraint has `Authorization#SPECIFIC_ROLE`, then the role set from the constraint that specified the `Authorization#SPECIFIC_ROLE` is used. only if the `mostSpecific` constraint has `Transport#INHERIT` is the `leastSpecific` constraint's `Transport` used, otherwise the `mostSpecific`'s is used.
public static Constraint	from(String... roles)
public static Constraint	from(String name, Constraint.Transport transport)
public static Constraint	from(String name, Constraint.Authorization authorization, String... roles)
public static Constraint	from(Constraint.Transport transport, Constraint.Authorization authorization, Set<String> roles)
public static Constraint	from(String name, Constraint.Transport transport, Constraint.Authorization authorization, Set<String> roles)
public Constraint.Authorization	getAuthorization() Returns: The `Authorization` criteria applied by this `Constraint` or null if this constraint does not have any authorization requirements.
public String	getName() Returns: The name for the `Constraint` or "unnamed@hashcode" if not named
public Set<String>	getRoles() Returns: The set of roles applied by this `Constraint` or the empty set.
public Constraint.Transport	getTransport() Returns: The required `Transport` or null if the transport can be either.

Field Detail

ALLOWED	back to summary
public static final Constraint ALLOWED A static Constraint that has `Authorization#ALLOWED` and `Transport#INHERIT`.

ALLOWED_ANY_TRANSPORT	back to summary
public static final Constraint ALLOWED_ANY_TRANSPORT A static Constraint that has `Authorization#ALLOWED` and `Transport#ANY`.

ANY_TRANSPORT	back to summary
public static final Constraint ANY_TRANSPORT A static Constraint that has `Transport#ANY` and `Authorization#INHERIT`

ANY_USER	back to summary
public static final Constraint ANY_USER A static Constraint that has `Authorization#ANY_USER` and `Transport#INHERIT`.

FORBIDDEN	back to summary
public static final Constraint FORBIDDEN A static Constraint that has `Authorization#FORBIDDEN` and `Transport#INHERIT`.

KNOWN_ROLE	back to summary
public static final Constraint KNOWN_ROLE A static Constraint that has `Authorization#KNOWN_ROLE` and `Transport#INHERIT`.

SECURE_TRANSPORT	back to summary
public static final Constraint SECURE_TRANSPORT A static Constraint that has `Transport#SECURE` and `Authorization#INHERIT`

Method Detail

combine back to summary

combine	back to summary
public static Constraint combine(Constraint leastSpecific, Constraint mostSpecific) Combine two Constraints by using `combine(String, Constraint, Constraint)` with a generated name. Parameters leastSpecific:Constraint Constraint to combine mostSpecific:Constraint Constraint to combine Returns:Constraint the combined constraint. See Also `combine(String, Constraint, Constraint)`

public static Constraint combine(Constraint leastSpecific, Constraint mostSpecific)

Combine two Constraints by using combine(String, Constraint, Constraint) with a generated name.

Parameters

leastSpecific:Constraint: Constraint to combine
mostSpecific:Constraint: Constraint to combine

Returns:Constraint

the combined constraint.

combine back to summary

combine	back to summary
public static Constraint combine(String name, Constraint leastSpecific, Constraint mostSpecific) Combine two Constraints by: if both constraints are `Null`, then `Constraint#ALLOWED` is returned. if either constraint is `Null` the other is returned. only if the `mostSpecific` constraint has `Authorization#INHERIT` is the `leastSpecific` constraint's `Authorization` used, otherwise the `mostSpecific`'s is used. if the combined constraint has `Authorization#SPECIFIC_ROLE`, then the role set from the constraint that specified the `Authorization#SPECIFIC_ROLE` is used. only if the `mostSpecific` constraint has `Transport#INHERIT` is the `leastSpecific` constraint's `Transport` used, otherwise the `mostSpecific`'s is used. Typically the path of the constraint is used to determine which constraint is most specific. For example if the following paths mapped to Constraints as: /* -> Authorization.FORBIDDEN,roles=[],Transport.SECURE /admin/* -> Authorization.SPECIFIC_ROLE,roles=["admin"],Transport.INHERIT The the `/admin/` constraint would be consider most specific and a request to `/admin/file` would have `Authorization#SPECIFIC_ROLE` from the `/admin/` constraint and `Transport#SECURE` inherited from the `/*` constraint. For more examples see `SecurityHandler.PathMapped`. Note that this combination is not equivalent to the combination done by the EE servlet specification. Parameters name:String The name to use for the combined constraint leastSpecific:Constraint Constraint to combine mostSpecific:Constraint Constraint to combine Returns:Constraint the combined constraint.

public static Constraint combine(String name, Constraint leastSpecific, Constraint mostSpecific)

Combine two Constraints by:

if both constraints are Null, then Constraint#ALLOWED is returned.
if either constraint is Null the other is returned.
only if the mostSpecific constraint has Authorization#INHERIT is the leastSpecific constraint's Authorization used, otherwise the mostSpecific's is used.
if the combined constraint has Authorization#SPECIFIC_ROLE, then the role set from the constraint that specified the Authorization#SPECIFIC_ROLE is used.
only if the mostSpecific constraint has Transport#INHERIT is the leastSpecific constraint's Transport used, otherwise the mostSpecific's is used.

Typically the path of the constraint is used to determine which constraint is most specific. For example if the following paths mapped to Constraints as:

    /*         -> Authorization.FORBIDDEN,roles=[],Transport.SECURE
    /admin/*   -> Authorization.SPECIFIC_ROLE,roles=["admin"],Transport.INHERIT

The the /admin/* constraint would be consider most specific and a request to /admin/file would have Authorization#SPECIFIC_ROLE from the /admin/* constraint and Transport#SECURE inherited from the /* constraint. For more examples see SecurityHandler.PathMapped.

Note that this combination is not equivalent to the combination done by the EE servlet specification.

Parameters

name:String: The name to use for the combined constraint
leastSpecific:Constraint: Constraint to combine
mostSpecific:Constraint: Constraint to combine

Returns:Constraint

the combined constraint.

from	back to summary
public static Constraint from(String... roles)

from	back to summary
public static Constraint from(String name, Constraint.Transport transport)

from	back to summary
public static Constraint from(String name, Constraint.Authorization authorization, String... roles)

from	back to summary
public static Constraint from(Constraint.Transport transport, Constraint.Authorization authorization, Set<String> roles)

from	back to summary
public static Constraint from(String name, Constraint.Transport transport, Constraint.Authorization authorization, Set<String> roles)

getAuthorization	back to summary
public Constraint.Authorization getAuthorization() Returns:Constraint.Authorization The `Authorization` criteria applied by this `Constraint` or null if this constraint does not have any authorization requirements.

getName	back to summary
public String getName() Returns:String The name for the `Constraint` or "unnamed@hashcode" if not named

getRoles	back to summary
public Set<String> getRoles() Returns:Set<String> The set of roles applied by this `Constraint` or the empty set.

getTransport	back to summary
public Constraint.Transport getTransport() Returns:Constraint.Transport The required `Transport` or null if the transport can be either.

org.eclipse.jetty.security back to summary

public final Enum Constraint.Authorization

Class Inheritance

extends Enum<Constraint.Authorization>

java.lang.Object
java.lang.Enum
org.eclipse.jetty.security.Constraint.Authorization

The Authorization applied to any authentication of the request/

Field Summary

Modifier and Type	Field and Description
public static final Constraint.Authorization	ALLOWED Access allowed.
public static final Constraint.Authorization	ANY_USER Access allowed for any authenticated user regardless of role.
public static final Constraint.Authorization	FORBIDDEN Access not allowed.
public static final Constraint.Authorization	INHERIT Inherit the authorization from a less specific constraint when passed to `combine(Constraint, Constraint)`, otherwise act as `ALLOWED`.
public static final Constraint.Authorization	KNOWN_ROLE Access allowed for authenticated user with any known role.
public static final Constraint.Authorization	SPECIFIC_ROLE Access allowed only for authenticated user with specific role(s).

Constructor Summary

Access	Constructor and Description
private	Authorization()

Method Summary

Modifier and Type	Method and Description
public static Constraint.Authorization	valueOf(String name)
public static Constraint.Authorization[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

ALLOWED	back to summary
public static final Constraint.Authorization ALLOWED Access allowed. Equivalent to Servlet AuthConstraint without any Authorization.

ANY_USER	back to summary
public static final Constraint.Authorization ANY_USER Access allowed for any authenticated user regardless of role. Equivalent to Servlet role "**". For example, a web application that defines only an "admin" can use this `Authorization` to allow any authenticated user known to the configured `LoginService`, even if their roles are not know to the web application.

FORBIDDEN	back to summary
public static final Constraint.Authorization FORBIDDEN Access not allowed. Equivalent to Servlet AuthConstraint with no roles.

INHERIT	back to summary
public static final Constraint.Authorization INHERIT Inherit the authorization from a less specific constraint when passed to `combine(Constraint, Constraint)`, otherwise act as `ALLOWED`.

KNOWN_ROLE back to summary

KNOWN_ROLE	back to summary
public static final Constraint.Authorization KNOWN_ROLE Access allowed for authenticated user with any known role. Equivalent to Servlet role "*". For example, a web application that defines roles "admin" and "user" might be deployed to a server with a configured `LoginService` that also has users with "operator" role. This constraint would not allow an "operator" user, as that role is not known to the web application.

public static final Constraint.Authorization KNOWN_ROLE

Access allowed for authenticated user with any known role. Equivalent to Servlet role "*". For example, a web application that defines roles "admin" and "user" might be deployed to a server with a configured LoginService that also has users with "operator" role. This constraint would not allow an "operator" user, as that role is not known to the web application.

SPECIFIC_ROLE	back to summary
public static final Constraint.Authorization SPECIFIC_ROLE Access allowed only for authenticated user with specific role(s).

Constructor Detail

Authorization	back to summary
private Authorization()

Method Detail

valueOf	back to summary
public static Constraint.Authorization valueOf(String name)

values	back to summary
public static Constraint.Authorization[] values()

org.eclipse.jetty.security back to summary

public Class Constraint.Builder

Class Inheritance

extends Object

java.lang.Object
org.eclipse.jetty.security.Constraint.Builder

Builder for Constraint.

Field Summary

Modifier and Type	Field and Description
private Constraint.Authorization	_authorization
private String	_name
private Set<String>	_roles
private Constraint.Transport	_transport

Constructor Summary

Access	Constructor and Description
public	Builder()
public	Builder(Constraint constraint)

Method Summary

Modifier and Type	Method and Description
public Constraint.Builder	authorization(Constraint.Authorization authorization)
public Constraint	build()
public Constraint.Authorization	getAuthorization()
public String	getName()
public Set<String>	getRoles()
public Constraint.Transport	getTransport()
public Constraint.Builder	name(String name)
public Constraint.Builder	roles(String... roles)
public Constraint.Builder	transport(Constraint.Transport transport)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

_authorization	back to summary
private Constraint.Authorization _authorization

_name	back to summary
private String _name

_roles	back to summary
private Set<String> _roles

_transport	back to summary
private Constraint.Transport _transport

Constructor Detail

Builder	back to summary
public Builder()

Builder	back to summary
public Builder(Constraint constraint)

Method Detail

authorization	back to summary
public Constraint.Builder authorization(Constraint.Authorization authorization)

build	back to summary
public Constraint build()

getAuthorization	back to summary
public Constraint.Authorization getAuthorization()

getName	back to summary
public String getName()

getRoles	back to summary
public Set<String> getRoles()

getTransport	back to summary
public Constraint.Transport getTransport()

name	back to summary
public Constraint.Builder name(String name)

roles	back to summary
public Constraint.Builder roles(String... roles)

transport	back to summary
public Constraint.Builder transport(Constraint.Transport transport)

org.eclipse.jetty.security back to summary

public final Enum Constraint.Transport

Class Inheritance

extends Enum<Constraint.Transport>

java.lang.Object
java.lang.Enum
org.eclipse.jetty.security.Constraint.Transport

The constraints requirement for the transport

Field Summary

Modifier and Type	Field and Description
public static final Constraint.Transport	ANY The transport can be either secure or not secure.
public static final Constraint.Transport	INHERIT Inherit the transport constraint from a less specific constraint when passed to `combine(Constraint, Constraint)`, otherwise act as `ANY`.
public static final Constraint.Transport	SECURE The transport must be secure (e.g. TLS)

Constructor Summary

Access	Constructor and Description
private	Transport()

Method Summary

Modifier and Type	Method and Description
public static Constraint.Transport	valueOf(String name)
public static Constraint.Transport[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

ANY	back to summary
public static final Constraint.Transport ANY The transport can be either secure or not secure.

INHERIT	back to summary
public static final Constraint.Transport INHERIT Inherit the transport constraint from a less specific constraint when passed to `combine(Constraint, Constraint)`, otherwise act as `ANY`.

SECURE	back to summary
public static final Constraint.Transport SECURE The transport must be secure (e.g. TLS)

Constructor Detail

Transport	back to summary
private Transport()

Method Detail

valueOf	back to summary
public static Constraint.Transport valueOf(String name)

values	back to summary
public static Constraint.Transport[] values()

public Interface Constraint

Nested and Inner Type Summary

Field Summary

Method Summary

Field Detail

Method Detail

public final Enum Constraint.Authorization

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class Constraint.Builder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum Constraint.Transport

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail