/**
* 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: SAMLv2Model.java,v 1.34 2009/11/24 21:48:40 madan_ranganath Exp $
*
* Portions Copyrighted 2010-2015 ForgeRock AS.
*/
public interface SAMLv2Model
extends EntityModel {
//SAMLv2 General attributes
"urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect";
"urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST";
"urn:oasis:names:tc:SAML:2.0:bindings:SOAP";
"urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Artifact";
"urn:oasis:names:tc:SAML:2.0:bindings:PAOS";
"urn:oasis:names:tc:SAML:2.0:bindings:URI";
//SAMLv2 IDP Standard attributes
"WantAuthnRequestsSigned";
"protocolSupportEnumeration";
"slohttpLocation";
"slohttpResponseLocation";
"slosoapLocation";
"mnihttpLocation";
"mnihttpResponseLocation";
"mnisoapLocation";
"ssohttpLocation";
"ssosoapLocation";
"singleChoiceSingleLogOutProfile";
"singleChoiceMangeNameIDProfile";
//SAMLv2 SP Standard attributes
"WantAssertionsSigned";
"protocolSupportEnumeration";
"slohttpLocation";
"slohttpResponseLocation";
"slosoapLocation";
"mnihttpLocation";
"mnihttpResponseLocation";
"mnisoapLocation";
"mnisoapResponseLocation";
"isDefaultSLO";
"isDefaultMNI";
//SAML2 IDP Extended Attributes
"signingCertAlias";
"signingCertKeyPass";
"encryptionCertAlias";
"wantNameIDEncrypted";
"nameIDFormatMap";
"wantLogoutRequestSigned";
"wantLogoutResponseSigned";
"idpAuthncontextMapper";
"idpDefaultAuthnContext";
"idpAuthncontextClassrefMapping";
"assertionNotBeforeTimeSkew";
"discoveryBootstrappingEnabled";
"wantArtifactResolveSigned";
"AuthUrl";
"assertionCacheEnabled";
"metaAlias";
"idpSessionSyncEnabled";
"enableProxyIDPFinderForAllSPs";
"proxyIDPFinderJSP";
//SAML2 SP Extended Attributes
"wantLogoutRequestSigned";
"wantLogoutResponseSigned";
"spDefaultAuthnContext";
"spAuthncontextClassrefMapping";
"spAuthncontextComparisonType";
"wantAttributeEncrypted";
"wantAssertionEncrypted";
"wantArtifactResponseSigned";
"wantPOSTResponseSigned";
"metaAlias";
"responseArtifactMessageEncoding";
"spSessionSyncEnabled";
//IDP PROXY
"useIntroductionForIDPProxy";
"useIDPFinder";
//ECP IDP
"idpECPSessionMapper";
//ECP SP
"ECPRequestIDPListFinderImpl";
"ECPRequestIDPList";
"ECPRequestIDPListGetComplete";
// SAE IDP
//SAE SP
// Relay State URL List IDP
// Relay State URL List SP
// SAMLv2 Service Provider Adapter feature
// SAMLv2 Service Provider Do not Write Federation Info Feature
//SAML AUTHORITY
"attrSerdefaultLocation";
"soapAssertionidrequest";
"uriAssertionIDRequest";
//SAML AUTHORITY Extended
"default_attributeAuthorityMapper";
"x509Subject_attributeAuthorityMapper";
"x509SubjectDataStoreAttrName";
"assertionIDRequestMapper";
"memberlist";
"affiliationOwnerID";
"txtProtocolSupportEnum";
"XACMLAuthzServiceBinding";
"XACMLAuthzServiceLocation";
"wantAssertionSigned";
"encryptionCertAlias";
"wantXACMLAuthzDecisionQuerySigned";
"wantXACMLAuthzDecisionResponseSigned";
"wantAssertionEncrypted";
// SAMLv2 IDP Adapter feature
/**
* Returns a map with standard identity provider attributes and values.
*
* @param realm to which the entity belongs.
* @param entityName is the entity id.
* @return Map with standard attribute values of Identity Provider.
* @throws AMConsoleException if unable to retrieve the Identity Provider
* attrubutes based on the realm and entityName passed.
*/
) throws AMConsoleException;
/**
* Returns a map with extended identity provider attributes and values.
*
* @param realm to which the entity belongs.
* @param entityName is the entity id.
* @return Map with extended attribute values of Identity Provider.
* @throws AMConsoleException if unable to retrieve the Identity Provider
* attrubutes based on the realm and entityName passed.
*/
) throws AMConsoleException;
/**
* Returns a map with standard service provider attributes and values.
*
* @param realm to which the entity belongs.
* @param entityName is the entity id.
* @return Map with standard attribute values of Service Provider.
* @throws AMConsoleException if unable to retrieve the Service Provider
* attrubutes based on the realm and entityName passed.
*/
) throws AMConsoleException;
/**
* Returns a List with Assertion Consumer Service attributes and values.
*
* @param realm to which the entity belongs.
* @param entityName is the entity id.
* @return List with Assertion Consumer values of Service Provider.
* @throws AMConsoleException if unable to retrieve the Service Provider
* Assertion Consumer values based on the realm and entityName passed.
*/
) throws AMConsoleException;
/*
*Returns a new AssertionConsumerServiceElement.
*
* @throws AMConsoleException if unable to retrieve.
*/
/**
* Returns a map with extended service provider attributes and values.
*
* @param realm to which the entity belongs.
* @param entityName is the entity id.
* @return Map with extended attribute values of Service Provider.
* @throws AMConsoleException if unable to retrieve the Service Provider
* attrubutes based on the realm and entityName passed.
*/
) throws AMConsoleException;
/**
* Saves the standard attribute values for the Identiy Provider.
*
* @param realm to which the entity belongs.
* @param entityName is the entity id.
* @param idpStdValues Map which contains the standard attribute values.
* @throws AMConsoleException if saving of attribute value fails.
*/
void setIDPStdAttributeValues(
) throws AMConsoleException;
/**
* Saves the extended attribute values for the Identity Provider.
*
* @param realm to which the entity belongs.
* @param entityName is the entity id.
* @param idpExtValues Map which contains the standard 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 Service Provider.
*
* @param realm to which the entity belongs.
* @param entityName is the entity id.
* @param spStdValues Map which contains the standard attribute values.
* @param assertionConsumer List with assertion consumer service values.
* @throws AMConsoleException if saving of attribute value fails.
*/
void setSPStdAttributeValues(
) throws AMConsoleException;
/**
* Saves the extended attribute values for the Service Provider.
*
* @param realm to which the entity belongs.
* @param entityName is the entity id.
* @param spExtValues Map which contains the standard attribute values.
* @param location has the information whether remote or hosted.
* @throws AMConsoleException if saving of attribute value fails.
*/
void setSPExtAttributeValues(
) throws AMConsoleException;
/**
* Returns SAMLv2 Extended Service Provider attribute values.
*
* @return SAMLv2 Extended Service Provider attribute values.
*/
/**
* Returns SAMLv2 Extended Service Provider values for Assertion Content.
*
* @return SAMLv2 Extended Service Provider values for Assertion Content.
*/
/**
* Returns SAMLv2 Extended Service Provider values for Assertion Processing.
*
* @return SAMLv2 Extended Service Provider values for Assertion Processing.
*/
/**
* Returns SAMLv2 Extended Service Provider attribute values for Services.
*
* @return SAMLv2 Extended Service Provider attribute values for Services.
*/
/**
* Returns SAMLv2 Extended Service Provider attribute values for Advanced.
*
* @return SAMLv2 Extended Service Provider attribute values for Advanced.
*/
/**
* Returns SAMLv2 Extended Identity Provider attribute values.
*
* @return SAMLv2 Extended Identity Provider attribute values.
*/
/**
* Returns SAMLv2 Extended Identity Provider values for Assertion Content.
*
* @return SAMLv2 Extended Identity Provider values for Assertion Content.
*/
/**
* Returns SAMLv2 Extended Identity Provider values for Assertion Processing.
*
* @return SAMLv2 Extended Identity Provider values for Assertion Processing.
*/
/**
* Returns SAMLv2 Extended Identity Provider attribute values for Services.
*
* @return SAMLv2 Extended Identity Provider attribute values for Services.
*/
/**
* Returns SAMLv2 Extended Identity Provider attribute values for Advanced.
*
* @return SAMLv2 Extended Identity Provider attribute values for Advanced.
*/
/**
* Returns SAMLv2 Xacml PEP ExtendedMeta
*
* @return SAMLv2 Xacml PEP Extended Meta.
*/
/**
* Returns SAMLv2 Xacml PDP ExtendedMeta
*
* @return SAMLv2 Xacml PDP Extended Meta.
*/
/**
* Returns a Map of PEP descriptor data.(Standard Metadata)
*
* @param realm realm of Entity
* @param entityName entity name of Entity Descriptor.
* @return key-value pair Map of PEP descriptor data.
* @throws AMConsoleException if unable to retrieve the PEP
* standard metadata attribute
*/
throws AMConsoleException;
/**
* Returns a Map of PDP descriptor data.(Standard Metadata)
*
* @param realm realm of Entity
* @param entityName entity name of Entity Descriptor.
* @return key-value pair Map of PDP descriptor data.
* @throws AMConsoleException if unable to retrieve the PDP
* standard metadata attribute
*/
throws AMConsoleException;
/**
* Returns a Map of PEP config data.(Extended Metadata)
*
* @param realm realm of Entity
* @param entityName entity name of Entity Descriptor.
* @param location entity is remote or hosted
* @throws AMConsoleException if unable to retrieve the PEP
* extended metadata attribute
*/
) throws AMConsoleException;
/**
* Returns a Map of PDP Config data.(Extended Metadata)
*
* @param realm where entity exists.
* @param entityName entity name of Entity Descriptor.
* @param location entity is remote or hosted
* @throws AMConsoleException if unable to retrieve the PEP
* extended metadata attribute
*/
) throws AMConsoleException;
/**
* save data for PDP descriptor data.(Standard Metadata)
*
* @param realm where entity exists.
* @param entityName entity name of Entity Descriptor.
* @param attrValues key-value pair Map of PDP standed data.
* @throws AMConsoleException if there is an error
*/
public void updatePDPDescriptor(
) throws AMConsoleException;
/**
* save data for PDP Config data.(Extended Metadata)
*
* @param realm realm of Entity
* @param entityName entity name of Entity Descriptor.
* @param location entity is remote or hosted
* @param attrValues key-value pair Map of PDP extended config.
*/
public void updatePDPConfig(
) throws AMConsoleException;
/**
* save data for PEP descriptor data.(Standard Metadata)
*
* @param realm realm of Entity
* @param entityName name of Entity Descriptor.
* @param attrValues key-value pair Map of PEP descriptor data.
* @throws AMConsoleException if there is an error
*/
public void updatePEPDescriptor(
) throws AMConsoleException;
/**
* Save the configuration data for the policy enforcment point (PEP) entity.
*
* @param realm where entity exists.
* @param entityName name of Entity Descriptor.
* @param location entity is remote or hosted.
* @param attrValues key-value pair Map of PEP extended config.
* @throws AMConsoleException if there is an error
*/
public void updatePEPConfig(
) throws AMConsoleException;
/**
* Returns the object of Auththentication Contexts in IDP.
*
* @param realm Realm of Entity
* @param entityName Name of Entity Descriptor.
* @return SAMLv2AuthContexts contains IDP authContexts values.
* @throws AMConsoleException if unable to retrieve the IDP
* Authentication Contexts
*/
) throws AMConsoleException ;
/**
* Returns the object of Auththentication Contexts in SP.
*
* @param realm Realm of Entity
* @param entityName Name of Entity Descriptor.
* @return SAMLv2AuthContexts contains SP authContexts values.
* @throws AMConsoleException if unable to retrieve the SP
* Authentication Contexts
*/
) throws AMConsoleException ;
/**
* update IDP Authentication Contexts
*
* @param realm Realm of Entity
* @param entityName Name of Entity Descriptor.
* @param cxt SAMLv2AuthContexts object contains IDP
* Authentication Contexts values
* @throws AMConsoleException if fails to update IDP
* Authentication Contexts.
*/
public void updateIDPAuthenticationContexts(
) throws AMConsoleException;
/**
* update SP Authentication Contexts
*
* @param realm Realm of Entity
* @param entityName Name of Entity Descriptor.
* @param cxt SAMLv2AuthContexts object contains SP
* Authentication Contexts values
* @throws AMConsoleException if fails to update SP
* Authentication Contexts.
*/
public void updateSPAuthenticationContexts(
) throws AMConsoleException;
/**
* Returns a map with standard AttributeAuthority attributes and values.
*
* @param realm to which the entity belongs.
* @param entityName is the entity id.
* @return Map with AttributeAuthority values.
* @throws AMConsoleException if unable to retrieve the std
* AttributeAuthority values based on the realm and entityName passed.
*/
) throws AMConsoleException;
/**
* Returns a map with extended AttributeAuthority attributes and values.
*
* @param realm to which the entity belongs.
* @param entityName is the entity id.
* @return Map with extended AttributeAuthority values.
* @throws AMConsoleException if unable to retrieve the extended
* AttributeAuthority attributes based on the realm and entityName passed.
*/
) throws AMConsoleException;
/**
* Returns a map with standard AuthnAuthority attributes and values.
*
* @param realm to which the entity belongs.
* @param entityName is the entity id.
* @return Map with AuthnAuthority values.
* @throws AMConsoleException if unable to retrieve std AuthnAuthority
* values based on the realm and entityName passed.
*/
) throws AMConsoleException;
/**
* Returns a map with extended AuthnAuthority attributes and values.
*
* @param realm to which the entity belongs.
* @param entityName is the entity id.
* @return Map with extended AuthnAuthority values.
* @throws AMConsoleException if unable to retrieve ext AuthnAuthority
* attributes based on the realm and entityName passed.
*/
) throws AMConsoleException;
/**
* Returns a map with standard AttrQuery attributes and values.
*
* @param realm to which the entity belongs.
* @param entityName is the entity id.
* @return Map with AttrQuery values.
* @throws AMConsoleException if unable to retrieve std AttrQuery
* values based on the realm and entityName passed.
*/
) throws AMConsoleException;
/**
* Returns a map with extended AttrQuery attributes and values.
*
* @param realm to which the entity belongs.
* @param entityName is the entity id.
* @return Map with extended AttrQuery values.
* @throws AMConsoleException if unable to retrieve ext AttrQuery
* attributes based on the realm and entityName passed.
*/
) throws AMConsoleException;
/**
* Saves the standard attribute values for Attribute Authority.
*
* @param realm to which the entity belongs.
* @param entityName is the entity id.
* @param attrAuthValues Map which contains standard attribute auth values.
* @throws AMConsoleException if saving of attribute value fails.
*/
public void setStdAttributeAuthorityValues(
) throws AMConsoleException;
/**
* Returns SAMLv2 Extended Attribute Authority values.
*
* @return SAMLv2 Extended Attribute Authority values.
*/
/**
* Saves the extended attribute values for Attribute Authority.
*
* @param realm to which the entity belongs.
* @param entityName is the entity id.
* @param attrAuthExtValues Map which contains the extended values.
* @param location has the information whether remote or hosted.
* @throws AMConsoleException if saving of attribute value fails.
*/
public void setExtAttributeAuthorityValues(
) throws AMConsoleException;
/**
* Saves the standard attribute values for Authn Authority.
*
* @param realm to which the entity belongs.
* @param entityName is the entity id.
* @param authnAuthValues Map which contains standard authn authority values.
* @throws AMConsoleException if saving of attribute value fails.
*/
public void setStdAuthnAuthorityValues(
) throws AMConsoleException;
/**
* Returns SAMLv2 Extended Authn Authority values.
*
* @return SAMLv2 Extended Authn Authority values.
*/
/**
* Saves the extended attribute values for Authn Authority.
*
* @param realm to which the entity belongs.
* @param entityName is the entity id.
* @param authnAuthExtValues Map which contains the extended authn values.
* @param location has the information whether remote or hosted.
* @throws AMConsoleException if saving of attribute value fails.
*/
public void setExtauthnAuthValues(
) throws AMConsoleException;
/**
* Saves the standard attribute values for Attribute Query.
*
* @param realm to which the entity belongs.
* @param entityName is the entity id.
* @param attrQueryValues Map which contains standard attribute query values.
* @throws AMConsoleException if saving of attribute value fails.
*/
public void setStdAttributeQueryValues(
) throws AMConsoleException;
/**
* Returns SAMLv2 Extended Attribute Query values.
*
* @return SAMLv2 Extended Attribute Query values.
*/
/**
* Saves the extended attribute values for Attribute Query.
*
* @param realm to which the entity belongs.
* @param entityName is the entity id.
* @param attrQueryExtValues Map which contains the extended values.
* @param location has the information whether remote or hosted.
* @throws AMConsoleException if saving of attribute value fails.
*/
public void setExtAttributeQueryValues(
) throws AMConsoleException;
/**
*Returns the metaAlias of the entity.
*
*@param realm to which the entity belongs.
*@param entityName is the entity id.
*@param role the Role of entity.
*@return the metaAlias of the entity.
*@throws AMConsoleException if unable to retrieve metaAlias.
*/
) throws AMConsoleException;
/**
* Returns a map with standard Affiliation attributes and values.
*
* @param realm to which the entity belongs.
* @param entityName is the entity id.
* @return Map with Affiliation values.
* @throws AMConsoleException if unable to retrieve standard Affiliation
* values based on the realm and entityName passed.
*/
) throws AMConsoleException;
/**
* Returns a map with extended Affiliation attributes and values.
*
* @param realm to which the entity belongs.
* @param entityName is the entity id.
* @return Map with extended Affiliation values.
* @throws AMConsoleException if unable to retrieve extended Affiliation
* attributes based on the realm and entityName passed.
*/
) throws AMConsoleException;
/**
* Saves the standard attribute values for Affilaition.
*
* @param realm to which the entity belongs.
* @param entityName is the entity id.
* @param affiliationValues Map which contains standard affiliation values.
* @param members Set which contains all members.
* @throws AMConsoleException if saving of attribute value fails.
*/
public void setStdAffilationValues(
) throws AMConsoleException;
/**
* Returns a set with all Service Providers under the realm.
*
* @param realm to which the entity belongs.
* @return Set with all service providers under the realm passed.
* @throws AMConsoleException if unable to retrieve service providers.
*
*/
/**
* Saves the signing and encryption values for entity.
*
* @param realm to which the entity belongs.
* @param entityName is the entity id.
* @param extValues Map which contains the extended attribute values.
* @param stdValues Map which contains the standard attribute values.
* @param isIDP has information whether entity is an idp or sp.
* @throws AMConsoleException if saving of attribute value fails.
*/
public void updateKeyinfo(
boolean isIDP
) throws AMConsoleException;
}