/*
 * 
 * Copyright 2004 Sun Microsystems, Inc. All Rights Reserved.
 * 
 * The contents of this file are subject to the Sun Community Source
 * License v3.0/Jini Technology Specific Attachment v 1.0 (the
 * "License"). You may not use this file except in compliance with the
 * License. You may obtain a copy of the License at
 * http://wwws.sun.com/software/jini/licensing/SCSL3_JiniTSA1.html.
 * Software distributed under the License is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 * the License for the specific language governing rights and limitations
 * under the License.
 * 
 * The Reference Code is Jini Technology Core Platform code, v2.0. The
 * Developer of the Reference Code is Sun Microsystems, Inc.
 * 
 * Contributor(s): Sun Microsystems, Inc.
 * 
 * The contents of this file comply with the Jini Technology Core
 * Platform Compatibility Kit, v2.0A.
 * 
 * Tester(s): Sun Microsystems, Inc.
 * 
 * Test Platform(s):
 * Java 2 SDK, Standard Edition, Version 1.4.2_03 for Solaris(TM)SPARC/x86
 * Java 2 SDK, Standard Edition, Version 1.4.2_03 for Linux (Intel x86)
 * Java 2 SDK, Standard Edition, Version 1.4.2_03 for Windows (Intel Platform)
 * 
 */

package net.jini.security;

import java.rmi.RemoteException;
import net.jini.config.Configuration;
import net.jini.core.constraint.RemoteMethodControl;
import net.jini.security.Security;

/**
 * Performs operations on a newly unmarshalled remote proxy to prepare it for
 * use. Typical operations include verifying trust in the proxy by calling
 * {@link Security#verifyObjectTrust Security.verifyObjectTrust}, specifying
 * constraints by calling {@link RemoteMethodControl#setConstraints
 * RemoteMethodControl.setConstraints}, and granting the proxy permissions by
 * calling {@link Security#grant Security.grant}. <p>
 *
 * Applications are expected to use instances of this class retrieved from a
 * {@link Configuration} to prepare all remote proxies that they receive in
 * order to permit configuring how applications handle proxies.
 *
 * @author Sun Microsystems, Inc.
 * @since 2.0
 */
public interface ProxyPreparer {

    /**
     * Performs operations on a newly unmarshalled proxy to prepare it for use,
     * returning the prepared proxy, which may or may not be the argument
     * itself. <p>
     *
     * Typical operations performed by this method include verifying trust in
     * the proxy by calling {@link Security#verifyObjectTrust
     * Security.verifyObjectTrust}, specifying constraints by calling {@link
     * RemoteMethodControl#setConstraints RemoteMethodControl.setConstraints},
     * and granting the proxy permissions by calling {@link Security#grant
     * Security.grant}.
     *
     * @param proxy the proxy to prepare
     * @return the prepared proxy
     * @throws NullPointerException if the proxy is <code>null</code>
     * @throws RemoteException if a communication-related exception occurs
     * @throws SecurityException if a security exception occurs
     */
    Object prepareProxy(Object proxy) throws RemoteException;
}
