org.jivesoftware.openfire.auth.AuthorizationMapping Maven / Gradle / Ivy
The newest version!
/*
* Copyright (C) 2004-2008 Jive Software. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.jivesoftware.openfire.auth;
/**
* This is the interface the used to provide default defualt authorization
* ID's when none was selected by the client.
*
* Users that wish to integrate with their own authorization
* system must implement this interface.
* Register the class with Openfire in the openfire.xml
* file. An entry in that file would look like the following:
*
*
* <provider>
* <authorizationMapping>
* <classlist>com.foo.auth.CustomProvider</classlist>
* </authorizationMapping>
* </provider>
*
* @author Jay Kline
*/
public interface AuthorizationMapping {
/**
* Returns true if the principal is explicity authorized to the JID
*
* @param principal The autheticated principal requesting authorization.
* @return The name of the default username to use.
*/
String map( String principal );
/**
* Returns the short name of the Policy
*
* @return The short name of the Policy
*/
String name();
/**
* Returns a description of the Policy
*
* @return The description of the Policy.
*/
String description();
}