org.jivesoftware.wildfire.sasl
Class DefaultAuthorizationProvider

java.lang.Object
  org.jivesoftware.wildfire.sasl.AbstractAuthorizationProvider
      org.jivesoftware.wildfire.sasl.DefaultAuthorizationProvider

All Implemented Interfaces:

AuthorizationProvider

public class DefaultAuthorizationProvider
extends AbstractAuthorizationProvider
implements AuthorizationProvider

Provider for authorization using the default storage database. Checks if the authenticated principal is in the user's list of authorized principals.

Author:

Jay Kline

Constructor Summary

DefaultAuthorizationProvider()

Method Summary

void	addAuthorized(String username, Collection<String> principals) Add a Collection of users authorized to use the named user.
void	addAuthorized(String username, String principal) Add a single authorized principal to use the named user.
boolean	authorize(String username, String principal) Returns true if the principal is explicity authorized to the JID
String	description() Returns a description of the Policy
Collection<String>	getAuthorized(String username) Returns a String Collection of principals that are authorized to use the named user.
boolean	isWritable() Returns true.
String	name() Returns the short name of the Policy
void	setAuthorized(String username, Collection<String> principals) Set the users authorized to use the named user.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultAuthorizationProvider

public DefaultAuthorizationProvider()

Method Detail

authorize

public boolean authorize(String username,
                         String principal)

Returns true if the principal is explicity authorized to the JID

Specified by:

authorize in interface AuthorizationProvider

Specified by:

authorize in class AbstractAuthorizationProvider

Parameters:

username - The username requested.

principal - The principal requesting the username.

Returns:

true is the user is authorized to be principal

getAuthorized

public Collection<String> getAuthorized(String username)

Returns a String Collection of principals that are authorized to use the named user.

Specified by:

getAuthorized in class AbstractAuthorizationProvider

Parameters:

username - The username.

Returns:

A String Collection of principals that are authorized.

isWritable

public boolean isWritable()

Returns true.

Specified by:

isWritable in class AbstractAuthorizationProvider

Returns:

true

addAuthorized

public void addAuthorized(String username,
                          String principal)
                   throws UnsupportedOperationException

Add a single authorized principal to use the named user.

Specified by:

addAuthorized in class AbstractAuthorizationProvider

Parameters:

username - The username.

principal - The principal authorized to use the named user.

Throws:

UnsupportedOperationException - If this AuthorizationProvider cannot be updated.

addAuthorized

public void addAuthorized(String username,
                          Collection<String> principals)
                   throws UnsupportedOperationException

Add a Collection of users authorized to use the named user.

Specified by:

addAuthorized in class AbstractAuthorizationProvider

Parameters:

username - The username.

principals - The Collection of principals authorized to use the named user.

Throws:

UnsupportedOperationException - If this AuthorizationProvider cannot be updated.

setAuthorized

public void setAuthorized(String username,
                          Collection<String> principals)
                   throws UnsupportedOperationException

Set the users authorized to use the named user. All existing principals listed will be removed.

Specified by:

setAuthorized in class AbstractAuthorizationProvider

Parameters:

username - The username.

principals - The Collection of principals authorized to use the named user.

Throws:

UnsupportedOperationException - If this AuthorizationProvider cannot be updated.

name

public String name()

Returns the short name of the Policy

Specified by:

name in class AbstractAuthorizationProvider

Returns:

The short name of the Policy

description

public String description()

Returns a description of the Policy

Specified by:

description in class AbstractAuthorizationProvider

Returns:

The description of the Policy.