Module com.zeroc.icegrid
Package com.zeroc.IceGrid

Class AdapterDescriptor

java.lang.Object
com.zeroc.IceGrid.AdapterDescriptor
All Implemented Interfaces:
Serializable, Cloneable
public final class AdapterDescriptor extends Object implements Cloneable, Serializable
Describes an indirect object adapter.

Remarks: The Slice compiler generated this class from Slice struct ::IceGrid::AdapterDescriptor.

See Also:

  • Field Details

    • name

      public String name
      The object adapter name.

    • description

      public String description
      A description of this object adapter.

    • id

      public String id
      The adapter ID.

    • replicaGroupId

      public String replicaGroupId
      The replica group ID. It's empty when the adapter is not part of a replica group.

    • priority

      public String priority
      The adapter priority. Only relevant when the adapter is in a replica group.

    • registerProcess

      public boolean registerProcess
      When true, the object adapter registers a process object.

    • serverLifetime

      public boolean serverLifetime
      When true, the lifetime of this object adapter is the same of the server lifetime. This information is used by the IceGrid node to figure out the server state: the server is active when all its "server lifetime" adapters are active.

    • objects

      public List<ObjectDescriptor> objects
      The descriptors of well-known objects.

    • allocatables

      public List<ObjectDescriptor> allocatables
      The descriptors of allocatable objects.

  • Constructor Details

    • AdapterDescriptor

      public AdapterDescriptor()
      Constructs a AdapterDescriptor.

    • AdapterDescriptor

      public AdapterDescriptor(String name, String description, String id, String replicaGroupId, String priority, boolean registerProcess, boolean serverLifetime, List<ObjectDescriptor> objects, List<ObjectDescriptor> allocatables)
      Constructs a AdapterDescriptor with values for all its fields.
      Parameters:
      name - The object adapter name.
      description - A description of this object adapter.
      id - The adapter ID.
      replicaGroupId - The replica group ID.
      priority - The adapter priority.
      registerProcess - When true, the object adapter registers a process object.
      serverLifetime - When true, the lifetime of this object adapter is the same of the server lifetime.
      objects - The descriptors of well-known objects.
      allocatables - The descriptors of allocatable objects.

  • Method Details

    • equals

      public boolean equals(Object rhs)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • clone

      public AdapterDescriptor clone()
      Overrides:
      clone in class Object

    • ice_writeMembers

      public void ice_writeMembers(OutputStream ostr)
      Marshals this object's fields into an output stream.
      Parameters:
      ostr - the output stream

    • ice_readMembers

      public void ice_readMembers(InputStream istr)
      Unmarshals and sets this object's fields from an input stream.
      Parameters:
      istr - the input stream

    • ice_write

      public static void ice_write(OutputStream ostr, AdapterDescriptor v)
      Marshals an AdapterDescriptor into an output stream.
      Parameters:
      ostr - the output stream
      v - the AdapterDescriptor to marshal

    • ice_read

      public static AdapterDescriptor ice_read(InputStream istr)
      Unmarshals an AdapterDescriptor from an input stream.
      Parameters:
      istr - the input stream
      Returns:
      the unmarshaled AdapterDescriptor

    • ice_write

      public static void ice_write(OutputStream ostr, int tag, Optional<AdapterDescriptor> v)
      Marshals an optional AdapterDescriptor into an output stream.
      Parameters:
      ostr - the output stream
      tag - the tag
      v - the value to marshal

    • ice_write

      public static void ice_write(OutputStream ostr, int tag, AdapterDescriptor v)
      Marshals an optional AdapterDescriptor into an output stream.
      Parameters:
      ostr - the output stream
      tag - the tag
      v - the value to marshal

    • ice_read

      public static Optional<AdapterDescriptor> ice_read(InputStream istr, int tag)
      Unmarshals an optional AdapterDescriptor from an input stream.
      Parameters:
      istr - the input stream
      tag - the tag
      Returns:
      the unmarshaled value