001/** 002 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. 003 * 004 * Copyright (c) 2006 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: ManageNameIDRequest.java,v 1.2 2008/06/25 05:47:57 qcheng Exp $ 026 * 027 * Portions Copyrighted 2016 ForgeRock AS. 028 */ 029 030 031package com.sun.identity.saml2.protocol; 032 033import com.fasterxml.jackson.annotation.JsonTypeInfo; 034import com.sun.identity.saml2.assertion.EncryptedID; 035import com.sun.identity.saml2.assertion.NameID; 036import com.sun.identity.saml2.common.SAML2Exception; 037import com.sun.identity.saml2.protocol.impl.ManageNameIDRequestImpl; 038 039/** 040 * This class represents the ManageNameIDRequestType complex type. 041 * <p>The following schema fragment specifies the expected 042 * content contained within this java content object. 043 * <p> 044 * <pre> 045 * <complexType name="ManageNameIDRequestType"> 046 * <complexContent> 047 * <extension base="{urn:oasis:names:tc:SAML:2.0:protocol}RequestAbstractType"> 048 * <sequence> 049 * <choice> 050 * <element ref="{urn:oasis:names:tc:SAML:2.0:assertion}NameID"/> 051 * <element ref="{urn:oasis:names:tc:SAML:2.0:assertion}EncryptedID"/> 052 * </choice> 053 * <choice> 054 * <element ref="{urn:oasis:names:tc:SAML:2.0:protocol}NewID"/> 055 * <element ref="{urn:oasis:names:tc:SAML:2.0:protocol}NewEncryptedID"/> 056 * <element ref="{urn:oasis:names:tc:SAML:2.0:protocol}Terminate"/> 057 * </choice> 058 * </sequence> 059 * </extension> 060 * </complexContent> 061 * </complexType> 062 * </pre> 063 * 064 * @supported.all.api 065 */ 066@JsonTypeInfo(include = JsonTypeInfo.As.PROPERTY, use = JsonTypeInfo.Id.CLASS, 067 defaultImpl = ManageNameIDRequestImpl.class) 068public interface ManageNameIDRequest extends RequestAbstract { 069 /** 070 * Returns the value of the <code>newEncryptedID</code> property. 071 * 072 * @return the value of the <code>newEncryptedID</code> property. 073 */ 074 NewEncryptedID getNewEncryptedID(); 075 076 /** 077 * Sets the value of the <code>newEncryptedID</code> property. 078 * 079 * @param value the value of the <code>newEncryptedID</code> property. 080 * @throws SAML2Exception if <code>Object</code> is immutable. 081 */ 082 void setNewEncryptedID(NewEncryptedID value) 083 throws SAML2Exception; 084 085 /** 086 * Returns the value of the <code>encryptedID</code> property. 087 * 088 * @return the value of the <code>encryptedID</code> property. 089 */ 090 EncryptedID getEncryptedID(); 091 092 /** 093 * Sets the value of the <code>encryptedID</code> property. 094 * 095 * @param value the value of the <code>encryptedID</code> property. 096 * @throws SAML2Exception if <code>Object</code> is immutable. 097 */ 098 void setEncryptedID(EncryptedID value) 099 throws SAML2Exception; 100 101 /** 102 * Returns the value of the <code>NewID</code> property. 103 * 104 * @return the value of the <code>NewID</code> property. 105 */ 106 NewID getNewID(); 107 108 /** 109 * Sets the value of the <code>NewID</code> property. 110 * 111 * @param value the value of the <code>NewID</code> property. 112 * @throws SAML2Exception if <code>Object</code> is immutable. 113 */ 114 void setNewID(NewID value) 115 throws SAML2Exception; 116 117 /** 118 * Returns the value of the <code>nameID</code> property. 119 * 120 * @return the value of the <code>nameID</code> property. 121 */ 122 NameID getNameID(); 123 124 /** 125 * Sets the value of the <code>nameID</code> property. 126 * 127 * @param value the value of the <code>nameID</code> property. 128 * @throws SAML2Exception if <code>Object</code> is immutable. 129 */ 130 void setNameID(NameID value) 131 throws SAML2Exception; 132 133 /** 134 * Returns true if this is a terminating request. 135 * 136 * @return true if this is a terminating request. 137 */ 138 boolean getTerminate(); 139 140 /** 141 * Set this request as terminating request. 142 * 143 * @param terminate true to set this request as terminating request. 144 * @throws SAML2Exception if this object is immutable. 145 */ 146 void setTerminate(boolean terminate) 147 throws SAML2Exception; 148}