|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.restlet.Restlet
org.restlet.routing.Filter
org.restlet.security.Authenticator
public abstract class Authenticator
Filter authenticating the client sending the request.
Field Summary |
---|
Fields inherited from class org.restlet.routing.Filter |
---|
CONTINUE, SKIP, STOP |
Constructor Summary | |
---|---|
Authenticator(Context context)
Constructor setting the mode to "required". |
|
Authenticator(Context context,
boolean optional)
Constructor using the context's default enroler. |
|
Authenticator(Context context,
boolean optional,
Enroler enroler)
Constructor. |
Method Summary | |
---|---|
protected abstract boolean |
authenticate(Request request,
Response response)
Attempts to authenticate the subject sending the request. |
protected int |
authenticated(Request request,
Response response)
Invoked upon successful authentication. |
protected int |
beforeHandle(Request request,
Response response)
Handles the authentication by first invoking the authenticate(Request, Response) method. |
Enroler |
getEnroler()
Returns the enroler invoked upon successful authentication to update the subject with new principals. |
boolean |
isOptional()
Indicates if the authenticator is not required to succeed. |
void |
setEnroler(Enroler enroler)
Sets the enroler invoked upon successful authentication. |
void |
setOptional(boolean optional)
Indicates if the authenticator is not required to succeed. |
protected int |
unauthenticated(Request request,
Response response)
Invoked upon failed authentication. |
Methods inherited from class org.restlet.routing.Filter |
---|
afterHandle, doHandle, getNext, handle, hasNext, setNext, setNext, start, stop |
Methods inherited from class org.restlet.Restlet |
---|
finalize, getApplication, getAuthor, getContext, getDescription, getLogger, getName, getOwner, isStarted, isStopped, setAuthor, setContext, setDescription, setName, setOwner |
Methods inherited from class java.lang.Object |
---|
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Authenticator(Context context)
context
- The context.Authenticator(Context, boolean)
public Authenticator(Context context, boolean optional)
context
- The context.optional
- The authentication mode.Authenticator(Context, boolean, Enroler)
public Authenticator(Context context, boolean optional, Enroler enroler)
context
- The context.optional
- The authentication mode.enroler
- The enroler to invoke upon successful authentication.Method Detail |
---|
protected abstract boolean authenticate(Request request, Response response)
request
- The request sent.response
- The response to update.
protected int beforeHandle(Request request, Response response)
authenticate(Request, Response)
method. Then, depending on the
result and the mode set, it invokes the
authenticated(Request, Response)
or the
unauthenticated(Request, Response)
method.
beforeHandle
in class Filter
request
- The request to handle.response
- The response to update.
Filter.CONTINUE
or
Filter.SKIP
or Filter.STOP
.protected int authenticated(Request request, Response response)
Filter.CONTINUE
.
request
- The request sent.response
- The response to update.
protected int unauthenticated(Request request, Response response)
Filter.STOP
.
request
- The request sent.response
- The response to update.
public Enroler getEnroler()
Role
are added based
on the available User
instances available.
public boolean isOptional()
public void setEnroler(Enroler enroler)
enroler
- The enroler invoked upon successful authentication.public void setOptional(boolean optional)
optional
- True if the authentication success is optional.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |