com.sun.jini.fiddler

Class FiddlerRegistration.ConstrainableFiddlerRegistration

java.lang.Object

com.sun.jini.fiddler.FiddlerRegistration

com.sun.jini.fiddler.FiddlerRegistration.ConstrainableFiddlerRegistration

All Implemented Interfaces:

Serializable, RemoteMethodControl, LookupDiscoveryRegistration, ReferentUuid

Enclosing class:

FiddlerRegistration

static final class FiddlerRegistration.ConstrainableFiddlerRegistration
extends FiddlerRegistration
implements RemoteMethodControl

The constrainable version of FiddlerRegistration.

When a client obtains an instance of this proxy class, the client should not attempt to use the proxy until the client is assured that the proxy can be trusted. In addition to implementing the methods and mechanisms required by RemoteMethodControl, this class - in conjunction with the service's ProxyVerifier class, helps provide a mechanism for verifying trust in the proxy on behalf of a client.

In order to verify that an instance of this class is trusted, trust must be verified in all subsidiary objects (contained in that instance) through which the client ultimately makes calls (local or remote). With respect to this class, the server field (which will be referred to as 'server1' for this description) is a proxy object through which the client makes remote calls to the service's backend. Therefore, trust in that object must be verified.

In addition to server1, this class also contains a field of type Uuid (registrationID), and a field of type EventRegistration (the field eventReg). Therefore, as with server1, trust must also be verified in each of these objects.

As indicated by the pattern described above, in order to verify trust in the subsidiary objects of this class, trust must also be verified in any subsidiary objects those objects themselves contain; and so on, until all subsidiary objects have been exhausted. The eventReg field contains such subsidiary objects that also contain subsidiary objects, each requiring verification. Those subsidiary objects are: a field of type ConstrainableFiddlerProxy (named source), and a field of type ConstrainableFiddlerLease (the field named lease, referred to below as 'lease1').

As with this class, the source field of eventReg is also an "outer proxy" to the service's backend, and thus also contains an (inner) proxy object (referred to below as 'server2') through which remote calls are made to the service's backend; thus, server2 must be verified. And since the lease field of eventReg also contains an (inner) proxy object ('server3'), that subsidiary object must be verified as well.

The description above is summarized in the following diagram:

    FiddlerRegistration {
        Fiddler server1
        Uuid registrationID
        EventRegistration eventReg {
            ConstrainableFiddlerProxy source {
                Fiddler server2
            }//end source
            ConstrainableFiddlerLease lease {
                Fiddler server3
            }//end lease
        }//end eventReg
    }//end FiddlerRegistration
  

Thus, in order to verify that an instance of this class is trusted, trust must be verified in the following objects from the diagram above:

• server1
• registrationID
• eventReg
  • source
    • server2
  • lease
    • server3

When a client obtains an instance of this proxy class, the deserialization process which delivers the proxy to the client invokes the readObject method of this class, as well as the readObject method for each subsidiary object, as the mechanism "walks" through the serialization graph. For each object that must be verified, part of that trust verification process is performed in the various readObject methods, and the remaining part is performed when the client prepares the proxy. This class' participation in the trust verification process can be summarized as follows:

• server1
  • readObject
    • verify server1 != null
    • verify registrationID != null
    • verify eventReg != null
    • verify eventReg is an instance of EventRegistration, but NOT a subclass of EventRegistration (if it's a subclass, then it's possible that the subclass contains methods that override the methods of EventRegistration with untrusted, un-constrained implementations)
    • verify eventReg.source != null
    • verify eventReg.source is an instance of FiddlerProxy
    • verify server2 != null (this is done in the readObject() of FiddlerProxy)
    • verify eventReg.lease is an instance of FiddlerLease
    • verify server3 != null (this is done in the readObject() of FiddlerLease)
    • verify server1 implements RemoteMethodControl
    • verify server1's method constraints are the same as those placed on the corresponding public Remote methods of its outer proxy class
    • verify eventReg.source is an instance of ConstrainableFiddlerProxy
    • verify lease is instance of ConstrainableFiddlerLease
  • proxy preparation
    • Security.verifyObjectTrust() which calls
    • ProxyVerifier.isTrustedObject(this) which calls
      • ProxyVerifier.isTrustedObject(source) which calls canonicalServerObject.checkTrustEquivalence(server2)
      • ProxyVerifier.isTrustedObject(lease) which calls canonicalServerObject.checkTrustEquivalence(server3)
      • canonicalServerObject.checkTrustEquivalence(server1) (whose implementation is supplied by the particular RMI implementation that was used to export the server)

Since:

2.0

Nested Class Summary

Nested classes/interfaces inherited from class com.sun.jini.fiddler.FiddlerRegistration

FiddlerRegistration.ConstrainableFiddlerRegistration

Field Summary

Fields

Modifier and Type	Field and Description
private MethodConstraints	methodConstraints Client constraints placed on this proxy (may be null).
private static Method[]	methodMapArray
(package private) static long	serialVersionUID

Fields inherited from class com.sun.jini.fiddler.FiddlerRegistration

eventReg, registrationID, server

Constructor Summary

Constructors

Modifier	Constructor and Description
private	FiddlerRegistration.ConstrainableFiddlerRegistration(Fiddler server, Uuid registrationID, EventRegistration eventReg, MethodConstraints methodConstraints) Constructs a new ConstrainableFiddlerRegistration instance.

Method Summary

Methods

Modifier and Type	Method and Description
private static Fiddler	constrainServer(Fiddler server, MethodConstraints constraints) Returns a copy of the given server proxy having the client method constraints that result after the specified method mapping is applied to the given client method constraints.
MethodConstraints	getConstraints() Returns the client constraints placed on the current instance of this proxy class (ConstrainableFiddlerRegistration).
private ProxyTrustIterator	getProxyTrustIterator() Returns a proxy trust iterator that is used in ProxyTrustVerifier to retrieve this object's trust verifier.
private void	readObject(ObjectInputStream s) Performs various functions related to the trust verification process for the current instance of this proxy class, as detailed in the description for this class.
RemoteMethodControl	setConstraints(MethodConstraints constraints) Returns a new copy of this proxy class (ConstrainableFiddlerRegistration) with its client constraints set to the specified constraints.

Methods inherited from class com.sun.jini.fiddler.FiddlerRegistration

addGroups, addLocators, createRegistration, discard, equals, getEventRegistration, getGroups, getLease, getLocators, getReferentUuid, getRegistrars, hashCode, removeGroups, removeLocators, setGroups, setLocators

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

methodMapArray

private static final Method[] methodMapArray

methodConstraints

private MethodConstraints methodConstraints

Client constraints placed on this proxy (may be null).

Constructor Detail

FiddlerRegistration.ConstrainableFiddlerRegistration

private FiddlerRegistration.ConstrainableFiddlerRegistration(Fiddler server,
                                                    Uuid registrationID,
                                                    EventRegistration eventReg,
                                                    MethodConstraints methodConstraints)

Constructs a new ConstrainableFiddlerRegistration instance.

For a description of all but the methodConstraints argument (provided below), refer to the description for the constructor of this class' super class.

Parameters:

methodConstraints - the client method constraints to place on this proxy (may be null).

Method Detail

constrainServer

private static Fiddler constrainServer(Fiddler server,
                      MethodConstraints constraints)

Returns a copy of the given server proxy having the client method constraints that result after the specified method mapping is applied to the given client method constraints.

setConstraints

public RemoteMethodControl setConstraints(MethodConstraints constraints)

Returns a new copy of this proxy class (ConstrainableFiddlerRegistration) with its client constraints set to the specified constraints. A null value is interpreted as mapping all methods to empty constraints.

Specified by:

setConstraints in interface RemoteMethodControl

Parameters:

constraints - client constraints, or null

Returns:

a new copy of this proxy with the client constraints set to the specified constraints

See Also:

RemoteMethodControl.getConstraints()

getConstraints

public MethodConstraints getConstraints()

Returns the client constraints placed on the current instance of this proxy class (ConstrainableFiddlerRegistration). The value returned by this method can be null, which is interpreted as mapping all methods to empty constraints.

Specified by:

getConstraints in interface RemoteMethodControl

Returns:

the client constraints, or null

See Also:

RemoteMethodControl.setConstraints(net.jini.core.constraint.MethodConstraints)

getProxyTrustIterator

private ProxyTrustIterator getProxyTrustIterator()

Returns a proxy trust iterator that is used in ProxyTrustVerifier to retrieve this object's trust verifier.

readObject

private void readObject(ObjectInputStream s)
                 throws IOException,
                        ClassNotFoundException

Performs various functions related to the trust verification process for the current instance of this proxy class, as detailed in the description for this class.

Throws:

InvalidObjectException - if any of the requirements for trust verification (as detailed in the class description) are not satisfied.

IOException

ClassNotFoundException