Package org.cometd.server.authorizer

Class GrantAuthorizer

java.lang.Object

org.cometd.server.authorizer.GrantAuthorizer

All Implemented Interfaces:

Authorizer

public class GrantAuthorizer
extends Object
implements Authorizer

This Authorizer implementation grants permission for a set of operations defined at construction time.

If the operation does not match, it ignores the authorization request.

Nested Class Summary

Nested classes/interfaces inherited from interface org.cometd.bayeux.server.Authorizer

Authorizer.Operation, Authorizer.Result

Field Summary

Fields

Modifier and Type	Field	Description
static GrantAuthorizer	GRANT_ALL	Grants Authorizer.Operation.CREATE, Authorizer.Operation.SUBSCRIBE and Authorizer.Operation.PUBLISH authorization
static GrantAuthorizer	GRANT_CREATE	Grants Authorizer.Operation.CREATE authorization
static GrantAuthorizer	GRANT_CREATE_SUBSCRIBE	Grants Authorizer.Operation.CREATE and Authorizer.Operation.SUBSCRIBE authorization
static GrantAuthorizer	GRANT_NONE	Grants no authorization, the authorization request is ignored
static GrantAuthorizer	GRANT_PUBLISH	Grants Authorizer.Operation.PUBLISH authorization
static GrantAuthorizer	GRANT_SUBSCRIBE	Grants Authorizer.Operation.SUBSCRIBE authorization
static GrantAuthorizer	GRANT_SUBSCRIBE_PUBLISH	Grants Authorizer.Operation.SUBSCRIBE and Authorizer.Operation.PUBLISH authorization

Method Summary

Modifier and Type	Method	Description
Authorizer.Result	authorize(Authorizer.Operation operation, ChannelId channel, ServerSession session, ServerMessage message)	Callback invoked to authorize the given operation on the given channel.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

GRANT_CREATE

public static final GrantAuthorizer GRANT_CREATE

Grants Authorizer.Operation.CREATE authorization

GRANT_SUBSCRIBE

public static final GrantAuthorizer GRANT_SUBSCRIBE

Grants Authorizer.Operation.SUBSCRIBE authorization

GRANT_PUBLISH

public static final GrantAuthorizer GRANT_PUBLISH

Grants Authorizer.Operation.PUBLISH authorization

GRANT_CREATE_SUBSCRIBE

public static final GrantAuthorizer GRANT_CREATE_SUBSCRIBE

Grants Authorizer.Operation.CREATE and Authorizer.Operation.SUBSCRIBE authorization

GRANT_SUBSCRIBE_PUBLISH

public static final GrantAuthorizer GRANT_SUBSCRIBE_PUBLISH

Grants Authorizer.Operation.SUBSCRIBE and Authorizer.Operation.PUBLISH authorization

GRANT_ALL

public static final GrantAuthorizer GRANT_ALL

Grants Authorizer.Operation.CREATE, Authorizer.Operation.SUBSCRIBE and Authorizer.Operation.PUBLISH authorization

GRANT_NONE

public static final GrantAuthorizer GRANT_NONE

Grants no authorization, the authorization request is ignored

Method Details

authorize

public Authorizer.Result authorize(Authorizer.Operation operation, ChannelId channel, ServerSession session, ServerMessage message)

Description copied from interface: Authorizer

Callback invoked to authorize the given operation on the given channel.

Additional parameters are passed to this method as context parameters, so that it is possible to implement complex logic based on the ServerSession and ServerMessage that are requesting the authorization.

Note that the message channel is not the same as the channelId parameter. For example, for subscription requests, the message channel is Channel.META_SUBSCRIBE, while the channelId parameter is the channel for which the subscription is requested.

Note that for create operation, the channel instance does not yet exist: it will be created only after the authorization is granted.

Specified by:

authorize in interface Authorizer

Parameters:

operation - the operation to authorize

channel - the channel for which the authorization has been requested

session - the session that is requesting the authorization

message - the message that triggered the authorization request

Returns:

the result of the authorization

toString

public String toString()

Overrides:

toString in class Object