Package org.faceless.publisher.type

Class CookieStoreURLConnectionProcessor

java.lang.Object

org.faceless.publisher.type.AbstractURLConnectionProcessor

org.faceless.publisher.type.CookieStoreURLConnectionProcessor

All Implemented Interfaces:

URLConnectionProcessor

public class CookieStoreURLConnectionProcessor
extends AbstractURLConnectionProcessor

A subclass of URLConnectionProcessor which can be used to serve, store and persist HTTP Cookies for any HTTP connections made to request resources.

Constructor Summary

Constructors

Constructor	Description
CookieStoreURLConnectionProcessor()	Create a new CookieStoreURLConnectionProcessor with the system CookieManager.
CookieStoreURLConnectionProcessor(CookieHandler handler)	Create a new CookieStoreURLConnectionProcessor with the specified CookieManager
CookieStoreURLConnectionProcessor(Path path)	Create a new CookieStoreURLConnectionProcessor with the system CookieManager.

Method Summary

Modifier and Type	Method	Description
URL2Connection	after(URL2Connection con)	If this processer matches, this method is called after the supplied URL connection is made.
void	before(URL2Connection con)	If this processer matches, this method is called before the supplied URL connection is made.
CookieHandler	getCookieHandler()	Return the CookieManager used by this class
Path	getPath()	Return the path most recently passed into load(java.nio.file.Path) or save(java.nio.file.Path)
void	load(Path path)	Load the cookies from the netscape/curl format \"cookiejar\" file at the specified path, if it exists
void	save(Path path)	Save the cookies from the netscape/curl format \"cookiejar\" file to the specified path, or if path is null, to the path last passed into load(java.nio.file.Path) or save(java.nio.file.Path).

Methods inherited from class org.faceless.publisher.type.AbstractURLConnectionProcessor

getMatches, matches

Methods inherited from class java.lang.Object

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

Constructor Details

CookieStoreURLConnectionProcessor

public CookieStoreURLConnectionProcessor()

Create a new CookieStoreURLConnectionProcessor with the system CookieManager. If no system CookieManager exists, create one.

CookieStoreURLConnectionProcessor

public CookieStoreURLConnectionProcessor(Path path)
                                  throws IOException

Create a new CookieStoreURLConnectionProcessor with the system CookieManager. If no system CookieManager exists, create one. and load the cookies from the specified path if it exists

Parameters:

path - the path to a netscape/curl style cookie-store, which will be loaded if it exists.

Throws:

IOException

CookieStoreURLConnectionProcessor

public CookieStoreURLConnectionProcessor(CookieHandler handler)

Create a new CookieStoreURLConnectionProcessor with the specified CookieManager

Parameters:

handler - the handler

Method Details

load

public void load(Path path)
          throws IOException

Load the cookies from the netscape/curl format \"cookiejar\" file at the specified path, if it exists

Parameters:

path - the file path to load.

Throws:

IOException

save

public void save(Path path)
          throws IOException

Save the cookies from the netscape/curl format \"cookiejar\" file to the specified path, or if path is null, to the path last passed into load(java.nio.file.Path) or save(java.nio.file.Path). If no path can be resolved, does nothing.

Parameters:

path - the file path to load

Throws:

IOException

getPath

public Path getPath()

Return the path most recently passed into load(java.nio.file.Path) or save(java.nio.file.Path)

getCookieHandler

public CookieHandler getCookieHandler()

Return the CookieManager used by this class

Returns:

the handler

before

public void before(URL2Connection con)
            throws IOException

Description copied from interface: URLConnectionProcessor

If this processer matches, this method is called before the supplied URL connection is made. It can alter any request headers.

Specified by:

before in interface URLConnectionProcessor

Overrides:

before in class AbstractURLConnectionProcessor

Parameters:

con - the connection

Throws:

IOException

after

public URL2Connection after(URL2Connection con)
                     throws IOException

Description copied from interface: URLConnectionProcessor

If this processer matches, this method is called after the supplied URL connection is made. It can act on the response headers, modify them for the next processor, and if it returns non-null, the request headers and URI of the returned value will be used for another request. For example to implement a redirect on a return code of 301

  if (con.getCode() == 301) {
      con.setURI(parse(con.getResponseHeader("location")));
      return con;
  } else {
      return null;
  }
 

Specified by:

after in interface URLConnectionProcessor

Overrides:

after in class AbstractURLConnectionProcessor

Parameters:

con - the connection

Returns:

the next connection to make, or null to accept this response

Throws:

IOException