com.sun.liberty.jaxrpc.LibertyManagerIF Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of openam-federation-library Show documentation

OpenAM Federation Library Components

There is a newer version: 14.8.4

Show newest version

/**
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2006 Sun Microsystems Inc. All Rights Reserved
 *
 * The contents of this file are subject to the terms
 * of the Common Development and Distribution License
 * (the License). You may not use this file except in
 * compliance with the License.
 *
 * You can obtain a copy of the License at
 * https://opensso.dev.java.net/public/CDDLv1.0.html or
 * opensso/legal/CDDLv1.0.txt
 * See the License for the specific language governing
 * permission and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL
 * Header Notice in each file and include the License file
 * at opensso/legal/CDDLv1.0.txt.
 * If applicable, add the following below the CDDL Header,
 * with the fields enclosed by brackets [] replaced by
 * your own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 *
 * $Id: LibertyManagerIF.java,v 1.2 2008/06/25 05:48:18 qcheng Exp $
 *
 */
package com.sun.liberty.jaxrpc;

import java.rmi.Remote;
import java.rmi.RemoteException;

/**
 * This interface LibertyManagerIF is a JAX-RPC interface
 * for the remote clients that require Liberty protocol objects such  
 * as Discovery Service information.
 * JSR196 client HTTP provider is one consumer of this interface.
 */
public interface LibertyManagerIF extends Remote {

    /**
     * Returns the discovery service bootstrap resource offering. 
     * @param tokenID Single Sign On Token ID.
     * @param hostProviderID Hosted ProviderID.
     * @return String Discovery Service ResourceOffering XML String.
     * @exception RemoteException if any failure.
     */
    public String getDiscoveryResourceOffering(
        String tokenID, String hostProviderID)
    throws RemoteException; 

    /**
     * Returns the discovery service credential.
     * @param tokenID Single Sign On Token ID.
     * @param hostProviderID Hosted ProviderID
     * @return String Discovery Service Credential XMLString.
     * @exception RemoteException if any failure.
     */ 
    public String getDiscoveryServiceCredential(
        String tokenID, String hostProviderID)
    throws RemoteException; 

}