org.glassfish.jersey.client.filter
Class CsrfProtectionFilter

java.lang.Object
  extended by org.glassfish.jersey.client.filter.CsrfProtectionFilter
All Implemented Interfaces:
ClientRequestFilter

public class CsrfProtectionFilter
extends Object
implements ClientRequestFilter

Simple client-side filter that adds X-Requested-By headers to all state-changing request (i.e. request for methods other than GET, HEAD and OPTIONS). This is to satisfy the requirements of the CsrfProtectionFilter on the server side.

Author:
Martin Matula (martin.matula at oracle.com)
See Also:
CsrfProtectionFilter

Field Summary
static String HEADER_NAME
          Name of the header this filter will attach to the request.
 
Constructor Summary
CsrfProtectionFilter()
          Creates a new instance of the filter with X-Requested-By header value set to empty string.
CsrfProtectionFilter(String requestedBy)
          Initialized the filter with a desired value of the X-Requested-By header.
 
Method Summary
 void filter(ClientRequestContext rc)
          Filter method called before a request has been dispatched to a client transport layer.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

HEADER_NAME

public static final String HEADER_NAME
Name of the header this filter will attach to the request.

See Also:
Constant Field Values
Constructor Detail

CsrfProtectionFilter

public CsrfProtectionFilter()
Creates a new instance of the filter with X-Requested-By header value set to empty string.


CsrfProtectionFilter

public CsrfProtectionFilter(String requestedBy)
Initialized the filter with a desired value of the X-Requested-By header.

Parameters:
requestedBy - Desired value of X-Requested-By header the filter will be adding for all potentially state changing requests.
Method Detail

filter

public void filter(ClientRequestContext rc)
            throws IOException
Description copied from interface: ClientRequestFilter
Filter method called before a request has been dispatched to a client transport layer. Filters in the filter chain are ordered according to their javax.annotation.Priority class-level annotation value.

Specified by:
filter in interface ClientRequestFilter
Parameters:
rc - request context.
Throws:
IOException - if an I/O exception occurs.


Copyright © 2007-2013, Oracle and/or its affiliates. All Rights Reserved. Use is subject to license terms.