001/** 002 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. 003 * 004 * Copyright (c) 2008 Sun Microsystems Inc. All Rights Reserved 005 * 006 * The contents of this file are subject to the terms 007 * of the Common Development and Distribution License 008 * (the License). You may not use this file except in 009 * compliance with the License. 010 * 011 * You can obtain a copy of the License at 012 * https://opensso.dev.java.net/public/CDDLv1.0.html or 013 * opensso/legal/CDDLv1.0.txt 014 * See the License for the specific language governing 015 * permission and limitations under the License. 016 * 017 * When distributing Covered Code, include this CDDL 018 * Header Notice in each file and include the License file 019 * at opensso/legal/CDDLv1.0.txt. 020 * If applicable, add the following below the CDDL Header, 021 * with the fields enclosed by brackets [] replaced by 022 * your own identifying information: 023 * "Portions Copyrighted [year] [name of copyright owner]" 024 * 025 * $Id: NameIDMappingRequest.java,v 1.2 2008/06/25 05:47:57 qcheng Exp $ 026 * 027 * Portions Copyrighted 2016 ForgeRock AS. 028 */ 029 030package com.sun.identity.saml2.protocol; 031 032import com.fasterxml.jackson.annotation.JsonTypeInfo; 033import com.sun.identity.saml2.assertion.EncryptedID; 034import com.sun.identity.saml2.assertion.NameID; 035import com.sun.identity.saml2.common.SAML2Exception; 036import com.sun.identity.saml2.protocol.impl.NameIDMappingRequestImpl; 037 038/** 039 * This class represents the ManageNameIDRequestType complex type. 040 * <p>The following schema fragment specifies the expected 041 * content contained within this java content object. 042 * <p> 043 * <pre> 044 * <complexType name="ManageNameIDRequestType"> 045 * <complexContent> 046 * <extension base="{urn:oasis:names:tc:SAML:2.0:protocol}RequestAbstractType"> 047 * <sequence> 048 * <choice> 049 * <element ref="{urn:oasis:names:tc:SAML:2.0:assertion}NameID"/> 050 * <element ref="{urn:oasis:names:tc:SAML:2.0:assertion}EncryptedID"/> 051 * </choice> 052 * <choice> 053 * <element ref="{urn:oasis:names:tc:SAML:2.0:protocol}NewID"/> 054 * <element ref="{urn:oasis:names:tc:SAML:2.0:protocol}NewEncryptedID"/> 055 * <element ref="{urn:oasis:names:tc:SAML:2.0:protocol}Terminate"/> 056 * </choice> 057 * </sequence> 058 * </extension> 059 * </complexContent> 060 * </complexType> 061 * </pre> 062 * 063 * @supported.all.api 064 */ 065 066@JsonTypeInfo(include = JsonTypeInfo.As.PROPERTY, use = JsonTypeInfo.Id.CLASS, 067 defaultImpl = NameIDMappingRequestImpl.class) 068public interface NameIDMappingRequest extends RequestAbstract { 069 /** 070 * Returns the value of the <code>encryptedID</code> property. 071 * 072 * @return the value of the <code>encryptedID</code> property. 073 */ 074 EncryptedID getEncryptedID(); 075 076 /** 077 * Sets the value of the <code>encryptedID</code> property. 078 * 079 * @param value the value of the <code>encryptedID</code> property. 080 * @throws SAML2Exception if <code>Object</code> is immutable. 081 */ 082 void setEncryptedID(EncryptedID value) 083 throws SAML2Exception; 084 085 /** 086 * Returns the value of the <code>nameID</code> property. 087 * 088 * @return the value of the <code>nameID</code> property. 089 */ 090 NameID getNameID(); 091 092 /** 093 * Sets the value of the <code>nameID</code> property. 094 * 095 * @param value the value of the <code>nameID</code> property. 096 * @throws SAML2Exception if <code>Object</code> is immutable. 097 */ 098 void setNameID(NameID value) 099 throws SAML2Exception; 100 101 /** 102 * Returns the value of the baseID property. 103 * 104 * @return the value of the baseID property 105 * @see #setBaseID(BaseID) 106 */ 107 public com.sun.identity.saml2.assertion.BaseID getBaseID(); 108 109 /** 110 * Sets the value of the baseID property. 111 * 112 * @param value the value of the baseID property to be set 113 * @throws SAML2Exception if the object is immutable 114 * @see #getBaseID 115 */ 116 public void setBaseID(com.sun.identity.saml2.assertion.BaseID value) 117 throws SAML2Exception; 118 119 /** 120 * Returns the <code>NameIDPolicy</code> object. 121 * 122 * @return the <code>NameIDPolicy</code> object. 123 * @see #setNameIDPolicy(NameIDPolicy) 124 */ 125 public NameIDPolicy getNameIDPolicy(); 126 127 /** 128 * Sets the <code>NameIDPolicy</code> object. 129 * 130 * @param nameIDPolicy the new <code>NameIDPolicy</code> object. 131 * @throws SAML2Exception if the object is immutable. 132 * @see #getNameIDPolicy 133 */ 134 135 public void setNameIDPolicy(NameIDPolicy nameIDPolicy) 136 throws SAML2Exception; 137 138 139}