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: SessionIndex.java,v 1.2 2008/06/25 05:47:58 qcheng Exp $ 026 * 027 */ 028 029 030package com.sun.identity.saml2.protocol; 031 032import com.sun.identity.saml2.common.SAML2Exception; 033 034/** 035 * This class represents the <code>SessionIndex</code> element in 036 * SAML protocol schema. 037 * The <code>SessionIndex</code> element specifies a session index value 038 * of a authenticated principal. 039 * 040 * <pre> 041 * <element name="SessionIndex" type="{http://www.w3.org/2001/XMLSchema}string"/> 042 * </pre> 043 * 044 * @supported.all.api 045 */ 046 047public interface SessionIndex { 048 049 /** 050 * Returns the <code>SessionIndex</code> value. 051 * 052 * @return A String value of the <code>SessionIndex</code> 053 * 054 */ 055 public java.lang.String getValue(); 056 057 /** 058 * Returns the <code>SessionIndex</code> in an XML document String format 059 * based on the <code>SessionIndex</code> schema described above. 060 * 061 * @return A XML String representing the <code>SessionIndex</code>. 062 * @throws SAML2Exception if some error occurs during conversion to 063 * <code>String</code>. 064 */ 065 public String toXMLString() throws SAML2Exception; 066 067 /** 068 * Returns the <code>SessionIndex</code> in an XML document String format 069 * based on the <code>SessionIndex</code> schema described above. 070 * @param includeNSPrefix Determines whether or not the namespace qualifier 071 * is prepended to the Element when converted 072 * 073 * @param declareNS Determines whether or not the namespace is declared 074 * within the Element. 075 * @return A XML String representing the <code>SessionIndex</code>. 076 * @throws SAML2Exception if some error occurs during conversion to 077 * <code>String</code>. 078 */ 079 public String toXMLString(boolean includeNSPrefix, boolean declareNS) 080 throws SAML2Exception; 081}
Copyright © 2010-2017, ForgeRock All Rights Reserved.