Class ServiceContextBase

  • Direct Known Subclasses:
    CodeSetServiceContextImpl, MaxStreamFormatVersionServiceContextImpl, ORBVersionServiceContextImpl, SendingContextServiceContextImpl, UEInfoServiceContextImpl, UnknownServiceContextImpl

    public abstract class ServiceContextBase
    extends java.lang.Object
    Base class for all ServiceContext classes. There is a derived ServiceContext class for each service context that the ORB supports. Each subclass encapsulates the representation of the service context and provides any needed methods for manipulating the service context. Each subclass must provide the following members:
    • a public static final int SERVICE_CONTEXT_ID that gives the OMG (or other) defined id for the service context. This is needed for the registration mechanism defined in ServiceContexts. OMG defined service context ids are taken from section 13.6.7 of ptc/98-12-04.
    • a public constructor that takes an InputStream as its argument.
    • Appropriate definitions of getId() and writeData(). getId() must return SERVICE_CONTEXT_ID.
    The subclass can be constructed either directly from the service context representation, or by reading the representation from an input stream. These cases are needed when the service context is created and written to the request or reply, and when the service context is read from the received request or reply.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private byte[] data
      Simple default constructor used when subclass is constructed from its representation.
      protected InputStream in
      in is the stream containing the service context representation.
      private static ORBUtilSystemException wrapper  
    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      abstract int getId()
      Returns Service context id.
      java.lang.String toString()  
      void write​(OutputStream s, GIOPVersion gv)
      Write the service context to an output stream.
      protected abstract void writeData​(OutputStream os)
      Writes the data used to represent the subclasses service context into an encapsulation stream.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Field Detail

      • data

        private byte[] data
        Simple default constructor used when subclass is constructed from its representation.
      • in

        protected InputStream in
        in is the stream containing the service context representation. It is constructed by the stream constructor, and available for use in the subclass stream constructor.
    • Constructor Detail

      • ServiceContextBase

        protected ServiceContextBase()
      • ServiceContextBase

        protected ServiceContextBase​(InputStream s)
        Stream constructor used when subclass is constructed from an InputStream. This constructor must be called by super( stream ) in the subclass. After this constructor completes, the service context representation can be read from in. Note that the service context id has been consumed from the input stream before this object is constructed.
        Parameters:
        s - stream to use to construct context
    • Method Detail

      • getId

        public abstract int getId()
        Returns Service context id. Must be overloaded in subclass.
        Returns:
        context id
      • write

        public void write​(OutputStream s,
                          GIOPVersion gv)
                   throws SystemException
        Write the service context to an output stream. This method must be used for writing the service context to a request or reply header.
        Parameters:
        s - stream to write to
        gv - version of the service context
        Throws:
        SystemException - if an error occurred writing to the stream
      • writeData

        protected abstract void writeData​(OutputStream os)
        Writes the data used to represent the subclasses service context into an encapsulation stream. Must be overloaded in subclass.
        Parameters:
        os - stream to write to
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object