org.apache.rahas.TokenIssuer Maven / Gradle / Ivy
/*
* Copyright 2004,2005 The Apache Software Foundation.
*
* 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.apache.rahas;
import org.apache.axiom.om.OMElement;
import org.apache.axiom.soap.SOAPEnvelope;
/**
* The TokenIssuer
*/
public interface TokenIssuer {
/**
* Create the response soap:Envelope for the given issue
* request.
*
* @param data A populated RahasData instance
* @return The response soap:Envelope for the given issue
* request.
* @throws TrustException If an error occurred while creating the token.
*/
SOAPEnvelope issue(RahasData data) throws TrustException;
/**
* Returns the wsa:Action of the response.
*
* @param data A populated RahasData instance
* @return Returns the wsa:Action of the response
* @throws TrustException If an error occurred while during operation.
*/
String getResponseAction(RahasData data) throws TrustException;
/**
* Set the configuration file of this TokenIssuer.
*
* This is the text value of the <configuration-file> element of the
* token-dispatcher-configuration
*
* @param configFile Sets the token issuer configuration file.
*/
void setConfigurationFile(String configFile);
/**
* Set the configuration element of this TokenIssuer.
*
* This is the <configuration> element of the
* token-dispatcher-configuration
*
* @param configElement OMElement representing the configuration
*/
void setConfigurationElement(OMElement configElement);
/**
* Set the name of the configuration parameter.
*
* If this is used then there must be a
* org.apache.axis2.description.Parameter object available in
* the via the messageContext when the TokenIssuer is called.
*
* @param configParamName The configuration parameter to be set.
* @see org.apache.axis2.description.Parameter
*/
void setConfigurationParamName(String configParamName);
}