WSFedPropertiesModel.java revision 4a2f0f0be43dfd4c1b490cbf3cc48b6ba6084b1c
/**
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2007 Sun Microsystems Inc. All Rights Reserved
*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the License). You may not use this file except in
* compliance with the License.
*
* You can obtain a copy of the License at
* See the License for the specific language governing
* permission and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* Header Notice in each file and include the License file
* at opensso/legal/CDDLv1.0.txt.
* If applicable, add the following below the CDDL Header,
* with the fields enclosed by brackets [] replaced by
* your own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]
*
* $Id: WSFedPropertiesModel.java,v 1.10 2008/08/30 01:23:29 babysunil Exp $
*
*/
public interface WSFedPropertiesModel extends EntityModel {
/************************************************************************
* WSFED General attributes
************************************************************************/
// attribute for name of entity
// attribute for display name of entity
// attribute for label for idp display name
// attribute for token issuer name
// attribute for token issuer end point
// attribute for role of entity
// attribute for protocol of entity
// attribute for realm to which entity belongs
/************************************************************************
* WSFED SP attributes
************************************************************************/
// attribute for AutofedEnabled
// attribute for ArtificatResponseSigned
// attribute for AutofedAttribute
// attribute for AssertionEffectiveTime
// attribute for AccountMapper
// attribute for description of entity
// attribute for AuthncontextMapper
// attribute for AuthncontextClassrefMapping
// attribute for AuthncontextComparisonType
// attribute for AttributeMap
// attribute for DefaultRelayState
// attribute for assertionTimeSkew
// attribute for Account Realm Cookie Name
// attribute for Account Realm Selection
// attribute for Home Realm Discovery Service
// attribute for label for user agent sting
// attribute for label for cookie name
/************************************************************************
* WSFED IDP attributes
************************************************************************/
// attribute for Signing Certificate Alias
//attribute for types of Claim Types Offered
//attribute for Claim Types Offered-Display Name
//attribute for Claim Types Offered-Description
//attribute for Claim Types Offered-Uri
// attribute for Claim Types Offered-Other
// attribute for AutofedEnabled
// attribute for AutofedAttribute
// attribute for AssertionEffectiveTime
// attribute for AuthncontextMapper
// attribute for AccountMapper
// attribute for AttributeMapper
// attribute for AttributeMap
/**
* Returns a map with service provider attributes and values.
*
* @param realm to which the entity belongs.
* @param fedid is the entity id.
* @return attribute values of SP based on realm and fedid passed.
* @throws AMConsoleException if unable to retreive the Service Provider
* attrubutes based on the realm and fedid passed.
*/
throws AMConsoleException;
/**
* Returns a map with identity provider attributes and values.
*
* @param realm to which the entity belongs.
* @param fedid is the entity id.
* @return attribute values of IDP based on realm and fedid passed.
* @throws AMConsoleException if unable to retreive the Identity Provider
* attrubutes based on the realm and fedid passed.
*/
throws AMConsoleException;
/**
* Returns FederationElement Object for the realm and fedid passed.
*
* @param realm to which the entity belongs.
* @param fedid is the entity id.
* @return FederationElement Object for the realm and fedid passed.
* @throws AMConsoleException if unable to retrieve the FederationElement
* Object.
*/
throws AMConsoleException;
/**
* Returns TokenIssuerName for the FederationElement passed.
*
* @param fedElem the FederationElement Object.
* @return TokenIssuerName for the FederationElement passed.
*/
/**
* Returns TokenIssuerEndPoint for the FederationElement passed.
*
* @param fedElem is the FederationElement Object.
* @return TokenIssuerEndPoint for the FederationElement passed.
*/
/**
* Returns display name of claim type.
*
* @param fedElem is the FederationElement Object.
* @return display name of claim type.
*/
/**
* Saves the extended metadata attribute values for the SP.
*
* @param realm to which the entity belongs.
* @param fedId is the entity id.
* @param spExtvalues contain the extended attribute values.
* @param location has the information whether remote or hosted.
* @throws AMConsoleException if saving of attribute value fails.
*/
void setSPExtAttributeValues(
) throws AMConsoleException;
/**
* Saves the extended metadata attribute values for the IDP.
*
* @param realm to which the entity belongs.
* @param fedId is the entity id.
* @param idpExtValues contain attribute values.
* @param location has the information whether remote or hosted.
* @throws AMConsoleException if saving of attribute value fails.
*/
void setIDPExtAttributeValues(
) throws AMConsoleException;
/**
* Saves the standard attribute values for the IDP.
*
* @param entityName is entityid.
* @param idpStdValues contain standard attribute values of idp.
* @param realm to which the entity belongs.
* @param idpExtValues contain extended attribute values.
* @param location the information whether remote or hosted.
* @throws AMConsoleException if saving of attribute value fails.
*/
void setIDPSTDAttributeValues(
) throws AMConsoleException;
/**
* Saves the standard attribute values from the General page.
*
* @param realm to which the entity belongs.
* @param fedId is the entity id.
* @param idpStdValues contain standard attribute values.
* @param role is this entity an sp or idp.
* @param location defines whether it is local or remote.
* @throws AMConsoleException if saving of attribute value fails.
*/
void setGenAttributeValues(
) throws AMConsoleException;
/**
* Returns a map of wsfed general attribute values.
*
* @return Map of wsfed general attribute values.
*/
/**
* Returns a map of wsfed general attribute values for dual role.
*
* @return Map of wsfed general attribute values for dual role.
*/
/**
* Returns a map of Wsfed Extended Service Provider attribute values.
*
* @return Map of Wsfed Extended Service Provider attribute values.
*/
/**
* Returns a map of Wsfed Extended Identity Provider attribute values.
*
* @return Map of Wsfed Extended Identity Provider attribute values.
*/
/**
* Returns a map of Wsfed Standard Identity Provider attribute values.
*
* @return Map of Wsfed Standard Identity Provider attribute values.
*/
}