Package com.swiftmq.swiftlet.auth

Class AuthenticationSwiftlet

java.lang.Object

com.swiftmq.swiftlet.Swiftlet

com.swiftmq.swiftlet.auth.AuthenticationSwiftlet

public abstract class AuthenticationSwiftlet
extends Swiftlet

The AuthenticationSwiftlet is responsible for user authenticating and resource usage verification.

Author:

IIT GmbH, Bremen/Germany, Copyright (c) 2000-2002, All Rights Reserved

Field Summary

Fields inherited from class com.swiftmq.swiftlet.Swiftlet

STATE_ACTIVE, STATE_INACTIVE, STATE_STANDBY

Constructor Summary

Constructors

Constructor	Description
AuthenticationSwiftlet()

Method Summary

Modifier and Type	Method	Description
abstract void	addTopicAuthenticationDelegate(AuthenticationDelegate delegate)
ActiveLogin	createActiveLogin(java.lang.String userName, java.lang.String type)	Creates an ActiveLogin object.
protected abstract java.lang.Object	createLoginId(java.lang.String userName)	Creates a unique login id.
protected abstract ResourceLimitGroup	createResourceLimitGroup(java.lang.String userName)	Creates a resource limit group
abstract java.lang.String	getPassword(java.lang.String userName)	Returns a user's password
abstract void	logout(java.lang.String userName, java.lang.Object loginId)	Log out of a user
abstract void	removeTopicAuthenticationDelegate(AuthenticationDelegate delegate)
abstract void	verifyHostLogin(java.lang.String username, java.lang.String hostname)	Verifies if the user is granted to login from the given host.
abstract void	verifyQueueBrowserCreation(java.lang.String queueName, java.lang.Object loginId)	Verifies if the user is granted to create a browser at the queue
abstract void	verifyQueueCreation(java.lang.Object loginId)	Verifies if the user is granted to create a queue
abstract void	verifyQueueReceiverSubscription(java.lang.String queueName, java.lang.Object loginId)	Verifies if the user is granted to subscribe to the queue as a receiver
abstract void	verifyQueueSenderSubscription(java.lang.String queueName, java.lang.Object loginId)	Verifies if the user is granted to subscribe to the queue as a sender
abstract void	verifySetClientId(java.lang.Object loginId)	Verifies if the user is granted to set a new client id
abstract void	verifyTopicDurableSubscriberCreation(java.lang.String topicName, java.lang.Object loginId)	Verifies if the user is granted to create a durable subscriber at the topic
abstract void	verifyTopicReceiverSubscription(java.lang.String topicName, java.lang.Object loginId)	Verifies if the user is granted to subscribe to a topic as a receiver
abstract void	verifyTopicSenderSubscription(java.lang.String topicName, java.lang.Object loginId)	Verifies if the user is granted to subscribe to a topic as a sender

Methods inherited from class com.swiftmq.swiftlet.Swiftlet

getName, getStartupTime, getState, isSnapshotAvailable, resume, setStartupTime, shutdown, standby, startup

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthenticationSwiftlet

public AuthenticationSwiftlet()

Method Detail

getPassword

public abstract java.lang.String getPassword(java.lang.String userName)
                                      throws AuthenticationException

Returns a user's password

Parameters:

userName - username

Throws:

AuthenticationException - if the user is unknown

createActiveLogin

public ActiveLogin createActiveLogin(java.lang.String userName,
                                     java.lang.String type)

Creates an ActiveLogin object.

Parameters:

userName - username

Returns:

active login

verifyHostLogin

public abstract void verifyHostLogin(java.lang.String username,
                                     java.lang.String hostname)
                              throws AuthenticationException,
                                     ResourceLimitException

Verifies if the user is granted to login from the given host.

Parameters:

username - username

hostname - hostname

Throws:

AuthenticationException - if he is not granted

ResourceLimitException - if the max number of concurrent connections for this user has been reached

verifySetClientId

public abstract void verifySetClientId(java.lang.Object loginId)
                                throws AuthenticationException

Verifies if the user is granted to set a new client id

Parameters:

loginId - login id

Throws:

AuthenticationException - if he is not granted

verifyQueueCreation

public abstract void verifyQueueCreation(java.lang.Object loginId)
                                  throws AuthenticationException

Verifies if the user is granted to create a queue

Parameters:

loginId - login id

Throws:

AuthenticationException - if he is not granted

verifyQueueSenderSubscription

public abstract void verifyQueueSenderSubscription(java.lang.String queueName,
                                                   java.lang.Object loginId)
                                            throws AuthenticationException

Verifies if the user is granted to subscribe to the queue as a sender

Parameters:

queueName - queue name

loginId - login id

Throws:

AuthenticationException - if he is not granted

verifyQueueReceiverSubscription

public abstract void verifyQueueReceiverSubscription(java.lang.String queueName,
                                                     java.lang.Object loginId)
                                              throws AuthenticationException

Verifies if the user is granted to subscribe to the queue as a receiver

Parameters:

queueName - queue name

loginId - login id

Throws:

AuthenticationException - if he is not granted

verifyQueueBrowserCreation

public abstract void verifyQueueBrowserCreation(java.lang.String queueName,
                                                java.lang.Object loginId)
                                         throws AuthenticationException

Verifies if the user is granted to create a browser at the queue

Parameters:

queueName - queue name

loginId - login id

Throws:

AuthenticationException - if he is not granted

verifyTopicSenderSubscription

public abstract void verifyTopicSenderSubscription(java.lang.String topicName,
                                                   java.lang.Object loginId)
                                            throws AuthenticationException

Verifies if the user is granted to subscribe to a topic as a sender

Parameters:

topicName - topic name

loginId - login id

Throws:

AuthenticationException - if he is not granted

verifyTopicReceiverSubscription

public abstract void verifyTopicReceiverSubscription(java.lang.String topicName,
                                                     java.lang.Object loginId)
                                              throws AuthenticationException

Verifies if the user is granted to subscribe to a topic as a receiver

Parameters:

topicName - topic name

loginId - login id

Throws:

AuthenticationException - if he is not granted

verifyTopicDurableSubscriberCreation

public abstract void verifyTopicDurableSubscriberCreation(java.lang.String topicName,
                                                          java.lang.Object loginId)
                                                   throws AuthenticationException

Verifies if the user is granted to create a durable subscriber at the topic

Parameters:

topicName - topic name

loginId - login id

Throws:

AuthenticationException - if he is not granted

addTopicAuthenticationDelegate

public abstract void addTopicAuthenticationDelegate(AuthenticationDelegate delegate)

removeTopicAuthenticationDelegate

public abstract void removeTopicAuthenticationDelegate(AuthenticationDelegate delegate)

logout

public abstract void logout(java.lang.String userName,
                            java.lang.Object loginId)

Log out of a user

Parameters:

userName - user name

loginId - login id

createLoginId

protected abstract java.lang.Object createLoginId(java.lang.String userName)

Creates a unique login id.

Parameters:

userName - user name

Returns:

login id

createResourceLimitGroup

protected abstract ResourceLimitGroup createResourceLimitGroup(java.lang.String userName)

Creates a resource limit group

Parameters:

userName - user name

Returns:

resource limit group