com.sun.xml.ws.security.SecurityContextTokenInfo Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of wssx-api Show documentation
There is a newer version: 4.0.4
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 1997-2017 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://oss.oracle.com/licenses/CDDL+GPL-1.1
 * or LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

package com.sun.xml.ws.security;

import org.glassfish.gmbal.Description;
import org.glassfish.gmbal.ManagedAttribute;
import org.glassfish.gmbal.ManagedData;

import java.util.Date;
import java.io.Serializable;
import java.util.Set;


/**
 * The SecurityContextTokenInfo class represents security parameters
 * which will be saved in the Session object so that whenever the endpoint
 * crashes the security negotiations can be resumed from its original state and no new 
 * negotiations need to be done.
 *
 */
@ManagedData(name="SecurityContextTokenInfo")
@Description("Security parameters")
public interface SecurityContextTokenInfo extends Serializable {

    @ManagedAttribute
    @Description("Identifier")
    String getIdentifier();

    void setIdentifier(String identifier);

    @ManagedAttribute
    @Description("External identifier")
    String getExternalId();

    void setExternalId(String externalId);
    
    String getInstance();

    void setInstance(String instance);

    @ManagedAttribute    
    @Description("Secret")
    byte[] getSecret();

    byte[] getInstanceSecret(String instance);

    void addInstance(String instance, byte[] key);

    @ManagedAttribute
    @Description("Creation time")
    Date getCreationTime();

    void setCreationTime(Date creationTime);

    @ManagedAttribute
    @Description("Expiration time")
    Date getExpirationTime();

    void setExpirationTime(Date expirationTime);
    
    Set getInstanceKeys();

    @ManagedAttribute
    @Description("Issued token context")
    IssuedTokenContext getIssuedTokenContext();

    IssuedTokenContext getIssuedTokenContext(SecurityTokenReference reference);
        
}