/**
* 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: IDFFModel.java,v 1.7 2008/11/18 22:39:42 asyhuang Exp $
*
*/
public interface IDFFModel
extends EntityModel {
"elistServerNameIdentifierMapping";
// standard meta data
"txtProtocolSupportEnum";
"tfSOAPEndpointURL";
"tfSingleSignOnServiceURL";
"tfSingleLogoutServiceURL";
"tfSingleLogoutReturnURL";
"tfFederationTerminationServiceURL";
"tfFederationTerminationReturnURL";
"tfNameRegistrationServiceURL";
"tfNameRegistrationReturnURL";
// communication profiles
"singleChoiceFederationTerminationProfile";
"singleChoiceSingleLogoutProfile";
"singleChoiceNameRegistrationProfile";
"singleChoiceFederationProfile";
//KeyDescriptor property.
"signingCertAlias";
"encryptionCertAlias";
"encryptionKeySize";
"encryptionAlgorithm";
"cbEnableNameIdentifierEncryption";
// SP standard meta Assertion Consumer Service URL property.
"tfAssertionConsumerServiceURLID";
"tfAssertionConsumerServiceURL";
"cbAssertionConsumerServiceURLasDefault";
"cbAuthnRequestsSigned";
// BOTH idp AND SP extended metadata
"doFederatePageURL";
"attributeMapperClass";
"enableAutoFederation";
"registrationDoneURL";
"cotlist";
"responsdWith";
"enableNameIDEncryption";
"ssoFailureRedirectURL";
"listOfCOTsPageURL";
"defaultAuthnContext";
"signingCertAlias";
"realmName";
"userProviderClass";
"nameIDImplementationClass";
"federationDoneURL";
"authType";
"encryptionCertAlias";
"terminationDoneURL";
"autoFederationAttribute";
"errorPageURL";
"providerStatus";
"providerDescription";
"logoutDoneURL";
"providerHomePageURL";
// IDP extend meta attribute ONLY IDP
// idp
"assertionLimit";
"attributePlugin";
"idpAttributeMap";
"assertionIssuer";
"cleanupInterval";
"idpAuthnContextMapping";
"generateBootstrapping";
"artifactTimeout";
"assertionInterval";
// SP extend meta attribute.. ONLY SP
"isPassive";
"spAttributeMap";
"spAuthnContextMapping";
"idpProxyList";
"enableIDPProxy";
"nameIDPolicy";
"federationSPAdapterEnv";
"enableAffiliation";
"forceAuthn";
"idpProxyCount";
"federationSPAdapter";
"useIntroductionForIDPProxy";
"supportedSSOProfile";
/**
* General Page attributes
*/
/* Attribute Name for Entity Descriptor Description. */
/* Attribute Name for Entity Descriptor Valid Until. */
/* Attribute Name for Entity Descriptor Cache Duration. */
/**
* Affiliate
*/
/* Attribute name of affiliate ID. */
"tfAffiliateID";
/* Attribute name of affiliate Owner ID. */
"tfAffiliateOwnerID";
/* Attribute name of affiliate's Valid Until. */
"tfAffiliateValidUntil";
/* Attribute name of affiliate's Cache Duration. */
"tfAffiliateCacheDuration";
/* Attribute name of Signing Key's Key Alias. */
"signingCertAlias";
/* Attribute name of Encryption Key's Key Alias. */
"encryptionCertAlias";
/* Attribute name of Encryption Key's Key Size. */
"encryptionKeySize";
/* Attribute name of Encryption Key's Key Method. */
"encryptionAlgorithm";
/* Attribute name of Affiliate Members. */
"arlistAffiliateMembers";
/**
* Returns provider-affiliate common attribute values.
*
* @param realm the realm in which the entity resides.
* @param entityName Name of Entity Descriptor.
* @return provider-affiliate common attribute values.
* @throws AMConsoleException if attribute values cannot be obtained.
*/
throws AMConsoleException;
/**
* Modifies entity descriptor profile.
*
* @param realm the realm in which the entity resides.
* @param entityName Name of entity descriptor.
* @param map Map of attribute type to a Map of attribute name to values.
* @throws AMConsoleException if profile cannot be modified.
*/
throws AMConsoleException;
/**
* Returns Map values of IDP Descriptor.
*
* @param realm Realm of Entity.
* @param entityName name of Entity Descriptor.
*/
throws AMConsoleException;
/**
* Returns Map values of SP Descriptor.
*
* @param entityName name of Entity Descriptor.
* @param realm Realm of Entity.
*/
throws AMConsoleException;
/**
* Returns attributes values of provider.
*
* @param entityName Name of Entity Descriptor.
* @param realm Realm of Entity
* @param location Location of provider such as Hosted or Remote.
* @return attributes values of provider.
*/
/**
* Returns attributes values of provider.
*
* @param realm Realm of Entity
* @param entityName Name of Entity Descriptor.
* @param location Location of provider such as Hosted or Remote.
* @return attributes values of provider.
*/
/**
* updateEntitySPDescriptor
* Modifies a service provider's standard metadata.
*
* @param entityName Name of Entity Descriptor.
* @param realm Realm of Entity
* @param attrValues Map of attribute name to set of values.
* @throws AMConsoleException if provider cannot be modified.
*/
public void updateEntitySPDescriptor(
boolean ishosted) throws AMConsoleException;
/**
* updateEntityIDPDescriptor
* Modifies a identity provider's standard metadata.
*
* @param entityName Name of Entity Descriptor.
* @param realm Realm of Entity
* @param attrValues Map of attribute name to set of values.
* @throws AMConsoleException if provider cannot be modified.
*/
public void updateEntityIDPDescriptor(
boolean ishosted) throws AMConsoleException;
/**
* updateIDPEntityConfig
* Modifies a provider's extended metadata.
*
* @param realm Realm of Entity
* @param entityName Name of Entity Descriptor.
* @param attrValues Map of attribute name to set of values.
* @throws AMConsoleException if provider cannot be modified.
*/
public void updateIDPEntityConfig(
/**
* updateSPEntityConfig
* Modifies a provider's extended metadata.
*
* @param entityName Name of Entity Descriptor.
* @param realm Realm of Entity
* @param attrValues Map of attribute name to set of values.
* @throws AMConsoleException if provider cannot be modified.
*/
public void updateSPEntityConfig(
/**
* createEntityConfig
* create a provider's extended metadata.
*
* @param entityName Name of Entity Descriptor.
* @param realm Realm of Entity
* @param location if the entity is remote or hosted.
* @throws AMConsoleException if provider cannot be modified.
*/
public void createEntityConfig(
/**
* Return a map with all SP extended metadata
*
* @return a map with all SP extended metadata
*/
/**
* Return a map with all IDP extended metadata
*
* @return a map with all IDP extended metadata
*/
/**
* Returns the object of Auththentication Contexts in IDP.
*
* @param realm Realm of Entity
* @param entityName Name of Entity Descriptor.
* @return attributes values of provider.
*/
/**
* Returns the object of Auththentication Contexts in SP.
*
* @param realm Realm of Entity
* @param entityName Name of Entity Descriptor.
* @return attributes values of provider.
*/
/**
* update IDP Authentication Contexts
*
* @param realm Realm of Entity
* @param entityName Name of Entity Descriptor.
* @param cxt IDFFAuthContexts object contains IDP
* Authentication Contexts values
*/
public void updateIDPAuthenticationContexts(
/**
* update SP Authentication Contexts
*
* @param realm Realm of Entity
* @param entityName Name of Entity Descriptor.
* @param cxt IDFFAuthContexts object contains SP
* Authentication Contexts values
*/
public void updateSPAuthenticationContexts(
/**
* Returns true if entity descriptor is an affiliate.
*
* @param realm Realm of Entity
* @param entityName Name of entity descriptor.
* @return true if entity descriptor is an affiliate.
*/
throws AMConsoleException;
/**
* Returns affiliate profile attribute values.
*
* @param realm the realm in which the entity resides.
* @param entityName Name of Entity Descriptor.
* @return affiliate profile attribute values.
* @throws AMConsoleException if attribute values cannot be obtained.
*/
throws AMConsoleException;
/**
* Modifies affiliate profile.
*
* @param realm the realm in which the entity resides.
* @param entityName Name of entity descriptor.
* @param members Set of Affiliate memebers
* @throws AMConsoleException if profile cannot be modified.
*/
public void updateAffiliateProfile(
/*
* Returns a Set of all the idff entities
*
* @param realm the realm in which the entity resides.
* @throws AMConsoleException if value cannot be obtained.
*/
throws AMConsoleException;
/*
* Returns a Set of all the affiliate entity name
*
* @param realm the realm in which the entity resides.
* @throws AMConsoleException if value cannot be obtained.
*/
throws AMConsoleException;
/*
* Returns a Set of all the affiliate members
*
* @param realm the realm in which the entity resides.
* @param entityName Name of Entity Descriptor.
* @throws AMConsoleException if values cannot be obtained.
*/
throws AMConsoleException;
}