Top Description Fields Constructors Methods
org.mortbay.jetty.security

public Class ClientCertAuthenticator

extends Object
implements Authenticator
Class Inheritance
All Implemented Interfaces
org.mortbay.jetty.security.Authenticator, java.io.Serializable
Imports
java.io.IOException, java.security.Principal, javax.servlet.http.HttpServletResponse, org.mortbay.jetty.Request, .Response

Client Certificate Authenticator. This Authenticator uses a client certificate to authenticate the user. Each client certificate supplied is tried against the realm using the Principal name as the username and a string representation of the certificate as the credential.
Author
Greg Wilkins (gregw)

Field Summary

Modifier and TypeField and Description
private int

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public Principal

Returns:

UserPrinciple if authenticated or null if not. If Authentication fails, then the authenticator may have committed the response as an auth challenge or redirect.
authenticate
(UserRealm
an UserRealm value
realm
,
String
a String value
pathInContext
,
Request
a Request value
request
,
Response
a Response value. If non-null response is passed, then a failed authentication will result in a challenge response being set in the response.
response
)

Implements org.mortbay.jetty.security.Authenticator.authenticate.

Authenticate.
public String
public int
public void
setMaxHandShakeSeconds(int
Maximum time to wait for SSL handshake if Client certification is required.
maxHandShakeSeconds
)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

_maxHandShakeSecondsback to summary
private int _maxHandShakeSeconds

Constructor Detail

ClientCertAuthenticatorback to summary
public ClientCertAuthenticator()

Method Detail

authenticateback to summary
public Principal authenticate(UserRealm realm, String pathInContext, Request request, Response response) throws IOException

Implements org.mortbay.jetty.security.Authenticator.authenticate.

Doc from org.mortbay.jetty.security.Authenticator.authenticate.

Authenticate.

Parameters
realm:UserRealm

an UserRealm value

pathInContext:String

a String value

request:Request

a Request value

response:Response

a Response value. If non-null response is passed, then a failed authentication will result in a challenge response being set in the response.

Returns:Principal

UserPrinciple if authenticated or null if not. If Authentication fails, then the authenticator may have committed the response as an auth challenge or redirect.

Exceptions
IOException:
if an error occurs
getAuthMethodback to summary
public String getAuthMethod()

Implements org.mortbay.jetty.security.Authenticator.getAuthMethod.

getMaxHandShakeSecondsback to summary
public int getMaxHandShakeSeconds()
setMaxHandShakeSecondsback to summary
public void setMaxHandShakeSeconds(int maxHandShakeSeconds)
Parameters
maxHandShakeSeconds:int

Maximum time to wait for SSL handshake if Client certification is required.