com.adaptris.core.http.jetty

Class SecurityConstraint

java.lang.Object

com.adaptris.core.http.jetty.SecurityConstraint

public class SecurityConstraint
extends java.lang.Object

A security constraint which allows you to place restrictions on a number of paths.

Given a single or multiple paths, you can set the roles that allow access.

By default we set a single path to "/". The list of paths can easily be overridden.

In the adapter configuration file this class is aliased as jetty-security-constraint which is the preferred alternative to the fully qualified classname when building your configuration.

Constructor Summary

Constructors

Constructor and Description
SecurityConstraint()

Method Summary

Modifier and Type	Method and Description
java.lang.String	constraintName()
java.lang.String	getConstraintName()
java.lang.Boolean	getMustAuthenticate()
java.util.List<java.lang.String>	getPaths()
java.lang.String	getRoles()
boolean	isMustAuthenticate()
void	setConstraintName(java.lang.String constraintName) Set the name of the constraint
void	setMustAuthenticate(java.lang.Boolean b) Whether or not we must authenticate.
void	setPaths(java.util.List<java.lang.String> paths)
void	setRoles(java.lang.String roles) A comma separated list of roles that the user must have to satisfy the constraint.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SecurityConstraint

public SecurityConstraint()

Method Detail

getRoles

public java.lang.String getRoles()

setRoles

public void setRoles(java.lang.String roles)

A comma separated list of roles that the user must have to satisfy the constraint.

Parameters:

roles - a comma separated list of roles

getMustAuthenticate

public java.lang.Boolean getMustAuthenticate()

isMustAuthenticate

public boolean isMustAuthenticate()

setMustAuthenticate

public void setMustAuthenticate(java.lang.Boolean b)

Whether or not we must authenticate.

Parameters:

b - true or false, the default is true if not explicitly specified.

getConstraintName

public java.lang.String getConstraintName()

setConstraintName

public void setConstraintName(java.lang.String constraintName)

Set the name of the constraint

Parameters:

constraintName - the name of the constraint; if not specified then defaults to 'BASIC' Constraint.__BASIC_AUTH.

See Also:

Constraint

constraintName

public java.lang.String constraintName()

getPaths

public java.util.List<java.lang.String> getPaths()

setPaths

public void setPaths(java.util.List<java.lang.String> paths)