Class ObjID
- java.lang.Object
-
- java.rmi.server.ObjID
-
- All Implemented Interfaces:
- Serializable
public final class ObjID extends Object implements Serializable
AnObjID
is used to identify a remote object exported to an RMI runtime. When a remote object is exported, it is assigned an object identifier either implicitly or explicitly, depending on the API used to export.The
ObjID()
constructor can be used to generate a unique object identifier. Such anObjID
is unique over time with respect to the host it is generated on. TheObjID(int)
constructor can be used to create a "well-known" object identifier. The scope of a well-knownObjID
depends on the RMI runtime it is exported to.An
ObjID
instance contains an object number (of typelong
) and an address space identifier (of typeUID
). In a uniqueObjID
, the address space identifier is unique with respect to a given host over time. In a well-knownObjID
, the address space identifier is equivalent to one returned by invoking theUID.UID(short)
constructor with the value zero.If the system property
java.rmi.server.randomIDs
is defined to equal the string"true"
(case insensitive), then theObjID()
constructor will use a cryptographically strong random number generator to choose the object number of the returnedObjID
.- Since:
- JDK1.1
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field and Description static int
ACTIVATOR_ID
Object number for well-knownObjID
of the activator.static int
DGC_ID
Object number for well-knownObjID
of the distributed garbage collector.static int
REGISTRY_ID
Object number for well-knownObjID
of the registry.
-
Constructor Summary
Constructors Constructor and Description ObjID()
Generates a unique object identifier.ObjID(int objNum)
Creates a "well-known" object identifier.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and Description boolean
equals(Object obj)
Compares the specified object with thisObjID
for equality.int
hashCode()
Returns the hash code value for this object identifier, the object number.static ObjID
read(ObjectInput in)
Constructs and returns a newObjID
instance by unmarshalling a binary representation from anObjectInput
instance.String
toString()
Returns a string representation of this object identifier.void
write(ObjectOutput out)
Marshals a binary representation of thisObjID
to anObjectOutput
instance.
-
-
-
Field Detail
REGISTRY_ID
public static final int REGISTRY_ID
Object number for well-knownObjID
of the registry.- See Also:
- Constant Field Values
ACTIVATOR_ID
public static final int ACTIVATOR_ID
Object number for well-knownObjID
of the activator.- See Also:
- Constant Field Values
DGC_ID
public static final int DGC_ID
Object number for well-knownObjID
of the distributed garbage collector.- See Also:
- Constant Field Values
-
Constructor Detail
ObjID
public ObjID()
Generates a unique object identifier.If the system property
java.rmi.server.randomIDs
is defined to equal the string"true"
(case insensitive), then this constructor will use a cryptographically strong random number generator to choose the object number of the returnedObjID
.
ObjID
public ObjID(int objNum)
Creates a "well-known" object identifier.An
ObjID
created via this constructor will not clash with anyObjID
s generated via the no-arg constructor.- Parameters:
-
objNum
- object number for well-known object identifier
-
Method Detail
write
public void write(ObjectOutput out) throws IOException
Marshals a binary representation of thisObjID
to anObjectOutput
instance.Specifically, this method first invokes the given stream's
DataOutput.writeLong(long)
method with this object identifier's object number, and then it writes its address space identifier by invoking itsUID.write(DataOutput)
method with the stream.- Parameters:
-
out
- theObjectOutput
instance to write thisObjID
to - Throws:
-
IOException
- if an I/O error occurs while performing this operation
read
public static ObjID read(ObjectInput in) throws IOException
Constructs and returns a newObjID
instance by unmarshalling a binary representation from anObjectInput
instance.Specifically, this method first invokes the given stream's
DataInput.readLong()
method to read an object number, then it invokesUID.read(DataInput)
with the stream to read an address space identifier, and then it creates and returns a newObjID
instance that contains the object number and address space identifier that were read from the stream.- Parameters:
-
in
- theObjectInput
instance to readObjID
from - Returns:
-
unmarshalled
ObjID
instance - Throws:
-
IOException
- if an I/O error occurs while performing this operation
hashCode
public int hashCode()
Returns the hash code value for this object identifier, the object number.- Overrides:
-
hashCode
in classObject
- Returns:
- the hash code value for this object identifier
- See Also:
-
Object.equals(java.lang.Object)
,System.identityHashCode(java.lang.Object)
equals
public boolean equals(Object obj)
Compares the specified object with thisObjID
for equality. This method returnstrue
if and only if the specified object is anObjID
instance with the same object number and address space identifier as this one.- Overrides:
-
equals
in classObject
- Parameters:
-
obj
- the object to compare thisObjID
to - Returns:
-
true
if the given object is equivalent to this one, andfalse
otherwise - See Also:
-
Object.hashCode()
,HashMap
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.