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: RequesterID.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 033 034import com.fasterxml.jackson.annotation.JsonTypeInfo; 035import com.sun.identity.saml2.common.SAML2Exception; 036import com.sun.identity.saml2.protocol.impl.RequesterIDImpl; 037 038/** 039 * This interface identifies the requester in an <code>AuthnRequest</code> 040 * message. 041 * 042 * @supported.all.api 043 */ 044 045@JsonTypeInfo(include = JsonTypeInfo.As.PROPERTY, use = JsonTypeInfo.Id.CLASS, 046 defaultImpl = RequesterIDImpl.class) 047public interface RequesterID { 048 049 /** 050 * Returns the value of the <code>RequesterID</code> URI. 051 * 052 * @return value of the <code>RequesterID</code> URI. 053 * @see #setValue 054 */ 055 public String getValue(); 056 057 /** 058 * Sets the value of the <code>RequesterID</code> URI. 059 * 060 * @param value of the <code>RequesterID<code> URI. 061 * @throws SAML2Exception if the object is immutable. 062 * @see #getValue 063 */ 064 public void setValue(String value) throws SAML2Exception; 065 066 /** 067 * Returns a String representation of this Object. 068 * 069 * @return a String representation of this Object. 070 * @throws SAML2Exception if cannot convert to String. 071 */ 072 public String toXMLString() throws SAML2Exception; 073 074 /** 075 * Returns a String representation of this Object. 076 * 077 * @param includeNSPrefix determines whether or not the namespace 078 * qualifier is prepended to the Element when converted 079 * @param declareNS determines whether or not the namespace is declared 080 * within the Element. 081 * @throws SAML2Exception if cannot convert to String. 082 * @return a String representation of this Object. 083 **/ 084 085 public String toXMLString(boolean includeNSPrefix,boolean declareNS) 086 throws SAML2Exception; 087 088 /** 089 * Makes this object immutable. 090 * 091 */ 092 public void makeImmutable() ; 093 094 /** 095 * Returns value true if object is mutable. 096 * 097 * @return true if object is mutable. 098 */ 099 public boolean isMutable(); 100}