com.sun.xml.ws.security.secconv.STRValidationHelper Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of webservices-rt Show documentation

This module contains the Metro runtime code.

There is a newer version: 4.0.4

/*
 * Copyright (c) 1997, 2018 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Distribution License v. 1.0, which is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */

package com.sun.xml.ws.security.secconv;

import com.sun.xml.ws.api.message.Packet;
import com.sun.xml.ws.security.secext10.SecurityTokenReferenceType;

/**
 * This interface is used by the RM server side to validate the SecurityTokenReference.
 */
public interface STRValidationHelper {
    /**
     * Get the active security token used by the specified packet for signing and encrypting the message.
     *   
     * @param packet
     * @return The reference URI to the security token context
     */
    public String getSecurityContextTokenId(Packet packet);
    
    /**
     * Get the security token reference URI from the specified wsse:SecurityTokenReference element.
     * 
     * @param str
     * @return The reference URI to the SecurityTokenReference
     * @throws Exception
     */
    public String extractSecurityTokenId(SecurityTokenReferenceType str) throws Exception;
}