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
void	addStaticHeaders(java.util.Map<java.lang.String,java.lang.String> staticHeaders) Adds a new map with static headers.
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.
HookTriggerType	getHookTriggerType() Retuns the trigger type of the hook.
java.util.List<java.lang.String>	getMethods() Returns the methods which should pass the hook.
int	getQueueExpireAfter() Gets the expiry (x-queue-expire-after header) for the requests in the queue send to the listener.
java.util.Map<java.lang.String,java.lang.String>	getStaticHeaders() Returns the map with the static headers for this hook.
boolean	isCollection() Indicates if a hook points to a collection (default: true) or not.
boolean	isFullUrl() Returns whether the hook forwards using the full initial url or only the appendix.
boolean	isListable() Indicates if a route hook should be listed for a GET request or not.
void	setCollection(boolean collection) Sets if a hook points to a collection (default: true) or not.
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	setHookTriggerType(HookTriggerType hookTriggerType) Sets the trigger type of the hook.
void	setListable(boolean listable) Sets if a route hook should be listed for a GET request or not.
void	setMethods(java.util.List<java.lang.String> methods) Sets the methods which should pass the hook.
void	setQueueExpireAfter(int queueExpireAfter) Sets the expiry (x-queue-expire-after header) for the requests in the queue send to the listener.

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

getQueueExpireAfter

public int getQueueExpireAfter()

Gets the expiry (x-queue-expire-after header) for the requests in the queue send to the listener. A -1 means that no expiry is set (the header will not be set).

Returns:

a value in seconds

setQueueExpireAfter

public void setQueueExpireAfter(int queueExpireAfter)

Sets the expiry (x-queue-expire-after header) for the requests in the queue send to the listener. A -1 means that no expiry is set (the header will not be set!).

Parameters:

queueExpireAfter - - a value in seconds

addStaticHeaders

public void addStaticHeaders(java.util.Map<java.lang.String,java.lang.String> staticHeaders)

Adds a new map with static headers.

Parameters:

staticHeaders - - a map with static headers

getStaticHeaders

public java.util.Map<java.lang.String,java.lang.String> getStaticHeaders()

Returns the map with the static headers for this hook.

Returns:

map with static headers or null if no static headers were defined

getHookTriggerType

public HookTriggerType getHookTriggerType()

Retuns the trigger type of the hook.

Returns:

the trigger type of the hook

setHookTriggerType

public void setHookTriggerType(HookTriggerType hookTriggerType)

Sets the trigger type of the hook. If nothing is set, the default value is 'before'.

Parameters:

hookTriggerType - the trigger type of the hook

isListable

public boolean isListable()

Indicates if a route hook should be listed for a GET request or not.

Returns:

true if the route hook should be listed

setListable

public void setListable(boolean listable)

Sets if a route hook should be listed for a GET request or not.

Parameters:

listable - true if the route hook should be listed

isCollection

public boolean isCollection()

Indicates if a hook points to a collection (default: true) or not.

Returns:

true (default) if hook points to collection.

setCollection

public void setCollection(boolean collection)

Sets if a hook points to a collection (default: true) or not.

Parameters:

collection - true (default) if hook points to collection.