se.rupy.http

Class Service

java.lang.Object

se.rupy.http.Service

Direct Known Subclasses:

Deploy, Root, Root.Find, Root.Hash, Root.Link, Root.Meta, Root.Node, Root.Salt, Root.Tree, User

public abstract class Service
extends java.lang.Object

The service filter is like a servlet which describes its own identifier. You have to be careful how you write your hot-deployable code, see the wiki for more information. The service becomes a singleton instance on the server, so use of static methods is recommended.

Field Summary

Fields

Modifier and Type	Field and Description
static int	CREATE When the session is created, read the incoming cookie key and/or set the key you wish to be stored, the domain and the expire date.
static int	DISCONNECT The client actively disconnected it's last TCP socket.
static int	TIMEOUT Normal timeout, the client simply was inactive for too long.

Constructor Summary

Constructors

Constructor and Description
Service()

Method Summary

Methods

Modifier and Type	Method and Description
void	create(Daemon daemon) Initiate service dependencies.
void	destroy() Free service dependencies.
abstract void	filter(Event event) The service method, equivalent of HttpServlet.service().
int	index() Where in the filter chain is this service? Default position is first (index 0).
abstract java.lang.String	path() The identifier that should trigger this service.
void	session(Session session, int type) If sessions are used and a session invokes a service, that service will then be notified before the session is added, so that you may assign your own session cookie id; or removed, so that you may act upon both session timeout and physical TCP disconnects.

Methods inherited from class java.lang.Object

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

Field Detail

CREATE

public static final int CREATE

When the session is created, read the incoming cookie key and/or set the key you wish to be stored, the domain and the expire date.

See Also:

Constant Field Values

TIMEOUT

public static final int TIMEOUT

Normal timeout, the client simply was inactive for too long. Timeout is specified when you start the daemon.

See Also:

Constant Field Values

DISCONNECT

public static final int DISCONNECT

The client actively disconnected it's last TCP socket. This will not work correctly if the server is placed behind a proxy.

See Also:

Constant Field Values

Constructor Detail

Service

public Service()

Method Detail

index

public int index()

Where in the filter chain is this service? Default position is first (index 0).

Returns:

the index of the service in it's filter chain.

path

public abstract java.lang.String path()

The identifier that should trigger this service. Or return null if you want to filter all 404 queries. For example "/admin". You can specify a service that should filter multiple identifiers by separating them with a ':' character. For example: if you want to identify a user before multiple services, return "/update:/query" here and set the index to 0 on the identity service and set index to 1 on the update and query filters. Then you use the following code to redirect to the login page for example:

 event.daemon().chain(event, "/login").filter(event);
 throw event; // stop the chain

or

 event.reply().header("Location", "/login");
 event.reply().code("302 Found");
 throw event; // stop the chain
 

Returns:

the path (URI) to the service(s).

create

public void create(Daemon daemon)
            throws java.lang.Exception

Initiate service dependencies. This is called when you hot-deploy the application / start the server. Important: This will be called for every chain instance of the service. So if you have multiple paths this will be called once for every path. Use static lock if you use this to start some singleton thread.

Parameters:

daemon - so you can setup yourself as a listener.

Throws:

java.lang.Exception

destroy

public void destroy()
             throws java.lang.Exception

Free service dependencies. This is called when you hot-deploy the application.

Throws:

java.lang.Exception

session

public void session(Session session,
           int type)
             throws java.lang.Exception

If sessions are used and a session invokes a service, that service will then be notified before the session is added, so that you may assign your own session cookie id; or removed, so that you may act upon both session timeout and physical TCP disconnects. On host cluster this gets invoked with a null context class loader.

Parameters:

session -

type -

Throws:

java.lang.Exception

filter

public abstract void filter(Event event)
                     throws Event,
                            java.lang.Exception

The service method, equivalent of HttpServlet.service().

Parameters:

event -

Throws:

Event - if you want to break the filter chain

java.lang.Exception