org.swisspush.gateleen.hook

Class HttpHook

java.lang.Object

org.swisspush.gateleen.hook.HttpHook

public class HttpHook
extends java.lang.Object

Represents a hook.

Constructor Summary

Constructors

Constructor and Description
HttpHook(java.lang.String destination) Creates a new hook.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDestination() The destination of the hook.
org.joda.time.LocalDateTime	getExpirationTime() Returns the expiration time of this hook.
int	getExpireAfter() Gets the expiry (x-expire-after header) for the requests send to the listener.
java.util.regex.Pattern	getFilter() Returns the precompiled pattern, to match a given url.
java.util.List<java.lang.String>	getMethods() Returns the methods which should pass the hook.
boolean	isFullUrl() Returns whether the hook forwards using the full initial url or only the appendix.
void	setDestination(java.lang.String destination) Sets the destination of the hook.
void	setExpirationTime(org.joda.time.LocalDateTime expirationTime) Sets the expiration time of this hook.
void	setExpireAfter(int expireAfter) Sets the expiry (x-expire-after header) for the requests send to the listener.
void	setFilter(java.lang.String regex) Set a regexp to filter the hook.
void	setFullUrl(boolean fullUrl) Sets whether the hook forwards using the full initial url or only the appendix.
void	setMethods(java.util.List<java.lang.String> methods) Sets the methods which should pass the hook.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpHook

public HttpHook(java.lang.String destination)

Creates a new hook.

Parameters:

destination - destination

Method Detail

getDestination

public java.lang.String getDestination()

The destination of the hook.

Returns:

String

setDestination

public void setDestination(java.lang.String destination)

Sets the destination of the hook.

Parameters:

destination - destination

getMethods

public java.util.List<java.lang.String> getMethods()

Returns the methods which should pass the hook.

Returns:

a list of HTTP methods or empty, if all methods do pass.

setMethods

public void setMethods(java.util.List<java.lang.String> methods)

Sets the methods which should pass the hook.

Parameters:

methods - a list of HTTP methods or empty, if all methods do pass.

getExpireAfter

public int getExpireAfter()

Gets the expiry (x-expire-after header) for the requests send to the listener.

Returns:

a value in seconds

setExpireAfter

public void setExpireAfter(int expireAfter)

Sets the expiry (x-expire-after header) for the requests send to the listener.

Parameters:

expireAfter - - a value in seconds

getExpirationTime

public org.joda.time.LocalDateTime getExpirationTime()

Returns the expiration time of this hook.

Returns:

expirationTime

setExpirationTime

public void setExpirationTime(org.joda.time.LocalDateTime expirationTime)

Sets the expiration time of this hook.

Parameters:

expirationTime - expirationTime

isFullUrl

public boolean isFullUrl()

Returns whether the hook forwards using the full initial url or only the appendix.

Returns:

fullUrl

setFullUrl

public void setFullUrl(boolean fullUrl)

Sets whether the hook forwards using the full initial url or only the appendix.

Parameters:

fullUrl - fullUrl

getFilter

public java.util.regex.Pattern getFilter()

Returns the precompiled pattern, to match a given url.

Returns:

- a precompiled pattern

setFilter

public void setFilter(java.lang.String regex)

Set a regexp to filter the hook.

Parameters:

regex - - a regular expression