| java.lang.Object
 org.apache.catalina.valves.ValveBase
org.apache.catalina.valves.CertificatesValve
| CertificatesValve | | final public class CertificatesValve extends ValveBase implements Lifecycle(Code) | | Implementation of a Valve that deals with SSL client certificates, as
follows:
|
| Field Summary | |
| protected boolean | certificates
| | final protected static CipherData | ciphers
A mapping table to determine the number of effective bits in the key
when using a cipher suite containing the specified cipher name. | | protected int | debug
The debugging detail level for this component. | | final protected static String | info
The descriptive information related to this implementation. | | protected LifecycleSupport | lifecycle
The lifecycle event support for this component. | | protected static StringManager | sm
The StringManager for this package. | | protected boolean | started
|
| Method Summary | |
| public void | addLifecycleListener(LifecycleListener listener)
Add a LifecycleEvent listener to this component. | | protected void | expose(Request request, Request actual)
Expose the certificate chain for this request, if there is one. | | public LifecycleListener[] | findLifecycleListeners()
Get the lifecycle listeners associated with this lifecycle. | | public int | getDebug()
Return the debugging detail level for this component. | | public String | getInfo()
Return descriptive information about this Valve implementation. | | public void | invoke(Request request, Response response, ValveContext context)
Expose the certificates chain if one was included on this request. | | protected void | log(String message)
Log a message on the Logger associated with our Container (if any). | | protected void | log(String message, Throwable throwable)
Log a message on the Logger associated with our Container (if any). | | public void | removeLifecycleListener(LifecycleListener listener)
Remove a LifecycleEvent listener from this component. | | public void | setDebug(int debug)
Set the debugging detail level for this component. | | public void | start()
Prepare for the beginning of active use of the public methods of this
component. | | public void | stop()
Gracefully terminate the active use of the public methods of this
component. | | protected void | verify(Request request, Request actual)
Verify that a client certificate chain exists if our web application
is doing client certificate authentication. |
| certificates | | protected boolean certificates(Code) | | Are certificates required for authentication by this web application?
|
| ciphers | | final protected static CipherData ciphers(Code) | | A mapping table to determine the number of effective bits in the key
when using a cipher suite containing the specified cipher name. The
underlying data came from the TLS Specification (RFC 2246), Appendix C.
|
| debug | | protected int debug(Code) | | The debugging detail level for this component.
|
| info | | final protected static String info(Code) | | The descriptive information related to this implementation.
|
| started | | protected boolean started(Code) | | Has this component been started yet?
|
| addLifecycleListener | | public void addLifecycleListener(LifecycleListener listener)(Code) | | Add a LifecycleEvent listener to this component.
Parameters:
listener - The listener to add |
| expose | | protected void expose(Request request, Request actual)(Code) | | Expose the certificate chain for this request, if there is one.
Parameters:
request - The possibly wrapped Request being processed
Parameters:
actual - The actual underlying Request object |
| findLifecycleListeners | | public LifecycleListener[] findLifecycleListeners()(Code) | | Get the lifecycle listeners associated with this lifecycle. If this
Lifecycle has no listeners registered, a zero-length array is returned.
|
| getDebug | | public int getDebug()(Code) | | Return the debugging detail level for this component.
|
| getInfo | | public String getInfo()(Code) | | Return descriptive information about this Valve implementation.
|
| invoke | | public void invoke(Request request, Response response, ValveContext context) throws IOException, ServletException(Code) | | Expose the certificates chain if one was included on this request.
Parameters:
request - The servlet request to be processed
Parameters:
response - The servlet response to be created
Parameters:
context - The valve context used to invoke the next valvein the current processing pipeline
exception:
IOException - if an input/output error occurs
exception:
ServletException - if a servlet error occurs |
| log | | protected void log(String message)(Code) | | Log a message on the Logger associated with our Container (if any).
Parameters:
message - Message to be logged |
| log | | protected void log(String message, Throwable throwable)(Code) | | Log a message on the Logger associated with our Container (if any).
Parameters:
message - Message to be logged
Parameters:
throwable - Associated exception |
| removeLifecycleListener | | public void removeLifecycleListener(LifecycleListener listener)(Code) | | Remove a LifecycleEvent listener from this component.
Parameters:
listener - The listener to remove |
| setDebug | | public void setDebug(int debug)(Code) | | Set the debugging detail level for this component.
|
| start | | public void start() throws LifecycleException(Code) | | Prepare for the beginning of active use of the public methods of this
component. This method should be called before any of the public
methods of this component are utilized. It should also send a
LifecycleEvent of type START_EVENT to any registered listeners.
exception:
LifecycleException - if this component detects a fatal errorthat prevents this component from being used |
| stop | | public void stop() throws LifecycleException(Code) | | Gracefully terminate the active use of the public methods of this
component. This method should be the last one called on a given
instance of this component. It should also send a LifecycleEvent
of type STOP_EVENT to any registered listeners.
exception:
LifecycleException - if this component detects a fatal errorthat needs to be reported |
| verify | | protected void verify(Request request, Request actual)(Code) | | Verify that a client certificate chain exists if our web application
is doing client certificate authentication.
Parameters:
request - The possibly wrapped Request being processed
Parameters:
actual - The actual underlying Request object |
|
|