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: SubjectStatement.java,v 1.2 2008/06/25 05:47:33 qcheng Exp $ 026 * 027 */ 028 029 030package com.sun.identity.saml.assertion; 031 032import org.w3c.dom.*; 033import java.util.*; 034import com.sun.identity.saml.common.SAMLUtilsCommon; 035 036/** 037 * The <code>SubjectStatement</code> element is an extension 038 * point that allows other assertion-based applications to reuse the SAML 039 * assertion framework. It contains a <code>Subject</code> element 040 * that allows issuer to describe a subject. Its 041 * <code>SubjectStatementAbstractType</code> complex type is abstract; 042 * extension elements must use <code>xsi:type</code> attribute to indicate 043 * the derived type. 044 * 045 * @supported.all.api 046 */ 047public abstract class SubjectStatement extends Statement { 048 //The subject 049 protected Subject _subject = null; 050 051 /** 052 *Default Constructor 053 */ 054 protected SubjectStatement() { 055 } 056 057 /** 058 * Returns the Subject within the <code>SubjectStatement</code>. 059 * 060 * @return The subject within the statement. 061 */ 062 public Subject getSubject() { 063 return _subject; 064 } 065 066 /** 067 * Set the Subject for the <code>SubjectStatement</code>. 068 * 069 * @param subject A Subject object. 070 * @return true if the operation is successful. 071 */ 072 public boolean setSubject(Subject subject) { 073 if (subject == null) { 074 if (SAMLUtilsCommon.debug.messageEnabled()) { 075 SAMLUtilsCommon.debug.message("SubjectStatement:setSubject:" + 076 "Input is null." ); 077 } 078 return false; 079 } 080 _subject = subject; 081 return true; 082 } 083 084 /** 085 * Creates a String representation of the <code>SubjectStatement</code>. 086 * 087 * @param includeNS Determines whether or not the namespace qualifier 088 * is prepended to the Element when converted. 089 * @param declareNS Determines whether or not the namespace is declared 090 * within the Element. 091 * @return A String representation of the 092 * <code><saml:SubjectStatement></code> element. 093 */ 094 public abstract String toString(boolean includeNS, boolean declareNS); 095} 096
Copyright © 2010-2017, ForgeRock All Rights Reserved.