Package com.groiss.wfxml

Class Partner

java.lang.Object
com.groiss.store.PersistentObject
com.groiss.wfxml.Partner
All Implemented Interfaces:
KeyValuePair<String,String>, Persistent, Serializable, Cloneable
public class Partner extends PersistentObject
Instances of this class represent WfXML communication partners. Use class WfXML2 (method WfXML2.getPartner(java.lang.String)) for retrieving objects of this class. If you want to create a new Partner, you have to do this in the administration of @enterprise. Go to Admin.-Tasks -> WfXML and add partner servers there. To retrieve one of this partners in your program, use the WfXML2.getPartner(java.lang.String) method and provide a valid partner id.
See Also:

  • Constructor Details

    • Partner

      public Partner()

  • Method Details

    • getId

      public String getId()
      Returns the ID of the communication partner. The ID is the unique identity with which you can request Partner objects from the WfXML2 class. If the partner is an @enterprise server, its ID must be its server name.
      Returns:
      The partner's ID.

    • setId

      public void setId(String id)

    • getOpmode

      public short getOpmode()

    • setOpmode

      public void setOpmode(short opmode)

    • getPathname

      public String getPathname()

    • setPathname

      public void setPathname(String pathname)

    • setProtocol

      public void setProtocol(String protocol)

    • setHostname

      public void setHostname(String hostname)

    • setPort

      public void setPort(int port)

    • getTableName

      public String getTableName()
      Description copied from interface: Persistent
      This method must return the table name of the database table in which this persistent object is stored.
      Returns:
      The table name of the database table in which this persistent object is stored.

    • getOperatingMode

      public short getOperatingMode()
      Use this method to find out if a partner works in passive, active, or off mode.
      Returns:
      A short value representing the operating mode of the local WfXML server. This is one of the values defined in WfXML2, e.g., WfXML2.MODE_ACTIVE.

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • getHostname

      public String getHostname()
      Returns the hostname of this partner as it is defined in the administration of @enterprise. The hostname may be the name of the host, or an IP address if no hostname is available.
      Returns:
      A String containing the hostname.

    • getPort

      public int getPort()
      The port on which the communication partner excepts incoming WfXML messages. This value is also defined in the administration of @enterprise.
      Returns:
      An integer value representing the port number on which WfXML messages are expected by the partner server.

    • getPath

      public String getPath()
      The path as defined in the administration of @enterprise. WfXML messages are sent using the HTTP protocol. This pathname defines which path will be sent with the HTTP request. In case of an @enterprise server, the path will be something similar to wf/servlet.method/com.groiss.wfxml.impl.Receiver.receive. The first part (wf) is the context root of this server. The other part identifies the method to which the request will be passed on.

      On other server (non @enterprise), the path can be significantly different.
      Returns:
      The path for that partner as defined in the @enterprise administration.

    • getURI

      public String getURI()
      Use this method to get a complete URI referring to the partner. The resulting String includes hostname, port, and path. For an @enterprise server it may look similar to:
      http://iquitos:8000/wf/servlet.method/com.groiss.wfxml.impl.Receiver.receive.
      Returns:
      The complete URI to the partner.

    • getProtocol

      public String getProtocol()