public final class ConstrainableLandlordLease extends LandlordLease implements RemoteMethodControl
LandlordLease
.
Instances of this class can be verified using the
LandlordProxyVerifier
class.LandlordProxyVerifier
,
Serialized FormModifier and Type | Field and Description |
---|---|
private static Method |
cancelAllMethod
Convenience field containing the
cancelAll method
defined in the Landlord interface. |
private static Method |
cancelMethod
Convenience field containing the
cancel method
defined in the Lease interface. |
private static Method[] |
comparableMethodsMapArray
canBatch needs to check if this lease and
the passed in lease have compatible constraints, this
is the set of methods to compare. |
(package private) static Method[] |
leaseMapMethodMapArray
When creating a
LeaseMap we generate an implicit
set of constraints based on the constraints found on the
the initial lease, where Lease.renew maps to
Landlord.renewAll and Lease.cancel maps to
Landlord.cancelAll . |
private MethodConstraints |
methodConstraints
Client constraints placed on this proxy (may be
null ) |
private static Method[] |
methodMapArray
Array containing element pairs in which each pair of elements
represents a mapping between two methods having the following
characteristics:
the first element in the pair is one of the public, remote
methods that may be invoked by the client through
Lease . |
private static Method |
renewAllMethod
Convenience field containing the
renewAll method
defined in the Landlord interface. |
private static Method |
renewMethod
Convenience field containing the
renew method
defined in the Lease interface. |
(package private) static long |
serialVersionUID |
expiration, serialFormat
Constructor and Description |
---|
ConstrainableLandlordLease(Uuid cookie,
Landlord landlord,
Uuid landlordUuid,
long expiration,
MethodConstraints methodConstraints)
Create a new
ConstrainableLandlordLease . |
Modifier and Type | Method and Description |
---|---|
boolean |
canBatch(Lease lease)
Returns a boolean indicating whether or not the lease given as a
parameter can be batched (placed in the same LeaseMap) with the
current lease.
|
private static Landlord |
constrainServer(Landlord server,
MethodConstraints constraints,
Method[] mapping)
Returns a copy of the given
Landlord proxy having the
client method constraints that result after a specified mapping
is applied to the given method constraints. |
LeaseMap |
createLeaseMap(long duration)
Creates a Map object that can contain leases whose renewal or
cancellation can be batched, and adds the current lease to that map.
|
MethodConstraints |
getConstraints()
Returns the client constraints placed on this proxy.
|
private static Method |
getMethod(Class type,
String name,
Class[] parameterTypes)
Returns the public method for the specified
Class type,
method name, and array of parameter types. |
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) |
RemoteMethodControl |
setConstraints(MethodConstraints constraints)
Returns a new copy of this proxy with the client constraints set to the
specified constraints.
|
cancel, cookie, doRenew, equals, getReferentUuid, hashCode, identity, landlord, landlordUuid, setExpiration, toString
getExpiration, getSerialFormat, renew, setSerialFormat
static final long serialVersionUID
private static final Method renewMethod
renew
method
defined in the Lease
interface. This field is used in the
method mapping arrays and when retrieving method constraints
for comparison in canBatch
.private static final Method cancelMethod
cancel
method
defined in the Lease
interface. This field is used in the
method mapping arrays and when retrieving method constraints
for comparison in canBatch
.private static final Method renewAllMethod
renewAll
method
defined in the Landlord
interface. This field is
used in the method mapping arrays.private static final Method cancelAllMethod
cancelAll
method
defined in the Landlord
interface. This field is
used in the method mapping arrays.private static final Method[] methodMapArray
Lease
.
static final Method[] leaseMapMethodMapArray
LeaseMap
we generate an implicit
set of constraints based on the constraints found on the
the initial lease, where Lease.renew
maps to
Landlord.renewAll
and Lease.cancel
maps to
Landlord.cancelAll
. This array holds this mapping.
Mapping also used by ConstrainableLandlordLeaseMap
in
canContainKey
.private static final Method[] comparableMethodsMapArray
canBatch
needs to check if this lease and
the passed in lease have compatible constraints, this
is the set of methods to compare. Structured so we can
use ConstrainableProxyUtil.equivalentConstraints(net.jini.core.constraint.MethodConstraints, net.jini.core.constraint.MethodConstraints, java.lang.reflect.Method[])
.private final MethodConstraints methodConstraints
null
)public ConstrainableLandlordLease(Uuid cookie, Landlord landlord, Uuid landlordUuid, long expiration, MethodConstraints methodConstraints)
ConstrainableLandlordLease
.cookie
- a Uuid
that universally and uniquely
identifies the lease this object is to be a proxy forlandlord
- Landlord
object that will be used to
communicate renew and cancel requests to the granter
of the lease.landlordUuid
- a universally unique id that has been
assigned to the server granting of the lease.
Ideally the Uuid
landlord.getUuid
would
return if landlord
implemented
ReferentUuid
. Used to determine when
two leases can be batched together.expiration
- The initial expiration time of the lease in
milliseconds since the beginning of the epoch.methodConstraints
- the client method constraints to place on
this proxy (may be null
).NullPointerException
- if landlord
,
landlordUuid
, or cookie
is null
.ClassCastException
- if landlord
does not implement RemoteMethodControl
.private static Method getMethod(Class type, String name, Class[] parameterTypes)
Class
type,
method name, and array of parameter types.
This method is typically used in place of Class.getMethod
to get a method that should definitely be defined;
thus, this method throws an error instead of an exception if the
given method is missing.
This method is convenient for the initialization of a static
variable for use as the mappings
argument to
ConstrainableProxyUtil.translateConstraints
.
type
- the Class
type that defines the
method of interestname
- String
containing the name of the
method of interestparameterTypes
- the Class
types of the parameters
to the method of interestMethod
object that provides information about,
and access to, the method of interestNoSuchMethodError
- if the method of interest
cannot be foundNullPointerException
- if type
or
name
is null
private static Landlord constrainServer(Landlord server, MethodConstraints constraints, Method[] mapping)
Landlord
proxy having the
client method constraints that result after a specified mapping
is applied to the given method constraints. For details on the
mapping see ConstrainableProxyUtil.translateConstraints
.server
- the proxy to attach constraints toconstraints
- the source method constraintsmapping
- mapping of methods to methodsNullPointerException
- if server
is
null
.ClassCastException
- if server
does not implement RemoteMethodControl
.public RemoteMethodControl setConstraints(MethodConstraints constraints)
RemoteMethodControl
getConstraints
method of the copy returns
the identical constraints instance. The original proxy is not modified.
A null
value is interpreted as mapping all methods to
empty constraints (one that has no requirements and no preferences).
For any given remote call, the specific client requirements and
preferences to be satisfied are given by the return value of invoking
the getConstraints
method of
the specified MethodConstraints
instance with a
Method
object representing the remote method.
Client constraints placed on a proxy are included in the serialized
state of the proxy. This allows third-party services to be transparent
to the client's needs. For example, if remote object s1
obtains a proxy for remote object s2
, and passes that
proxy to remote object s3
, expecting s3
to
invoke a remote method on s2
, then s1
can
control that call by placing its constraints directly on the proxy
before passing it to s3
. If s3
does not
wish to be transparent in this way, then it should explicitly replace
the client constraints on received proxies with whatever constraints
are appropriate to implement its own policy.
setConstraints
in interface RemoteMethodControl
constraints
- client constraints, or null
RemoteMethodControl.getConstraints()
public MethodConstraints getConstraints()
RemoteMethodControl
null
, which is interpreted as mapping all
methods to empty constraints (one that has no requirements and no
preferences).getConstraints
in interface RemoteMethodControl
null
RemoteMethodControl.setConstraints(net.jini.core.constraint.MethodConstraints)
private ProxyTrustIterator getProxyTrustIterator()
ProxyTrustVerifier
to retrieve this object's
trust verifier.private void readObject(ObjectInputStream s) throws IOException, ClassNotFoundException
IOException
ClassNotFoundException
public boolean canBatch(Lease lease)
Lease
canBatch
in interface Lease
canBatch
in class LandlordLease
lease
- the Lease to be evaluatedpublic LeaseMap createLeaseMap(long duration)
Lease
createLeaseMap
in interface Lease
createLeaseMap
in class LandlordLease
duration
- the duration to put into a Long and use as the
value for the current lease in the created LeaseMapCopyright 2007-2013, multiple authors.
Licensed under the Apache License, Version 2.0, see the NOTICE file for attributions.