com.ibm.tws.objects.model
Class Workstation

java.lang.Object
  extended bycom.ibm.tws.objects.model.FlowTarget
      extended bycom.ibm.tws.objects.model.Workstation
All Implemented Interfaces:
java.io.Serializable, TWSObject

public class Workstation
extends FlowTarget

This subclass of FlowTarget represents a workstation, and references a domain and a host workstation (for XA or SA type). Through means of FlowTarget, Workstation wraps a WorkstationHeader, and the header in turn wraps a FlowTargetKey object through means of FlowNodeHeader.

The following syntax validation constraints must be met on Workstation objects in distributed environment:

type One of the values exposed by the WorkstationType class
Always required
os One of the values exposed by the OperatingSystem class
Always required
timeZone If specified, must be allowed by TZ library and Java
Not longer than 40 characters
nodeName Always required
Not longer than 51 characters
Must be a valid hostname or internet address
securityLevel One of the values exposed by the SecurityLevel class
Required if type is not XA
Must be null if type is XA
behindFirewall Default value is false
tcpPort Allowed range is from 0 to 65,535
Default value is 31,111
sslPort Allowed range is from 0 to 65,535
Default value is 31,113
domainKey If specified, must reference an existing domain
Must be null if type is XA
autoLink Default value is false
fullStatus Must be true if type is MANAGER
Default value is false
server An alphanumeric character, or a blank space
Default value is a blank space
accessMethod Required if type is XA
Not longer than 40 characters
Must be null if type is not XA
isHostedByMaster Default value is false
hostWorkstationKey If specified, must reference an existing workstation
Required if type is XA
Must be null if type is FTA or MANAGER
Must be null if isHostedByMaster is true

The following syntax validation constraints must be met on Workstation objects in z/OS environment:

name Always required
Alphanumeric characters
Starting with alphabetic character
Blank spaces not allowed
Not longer than 4 characters
description Not longer than 32 characters
type One of the following values of the WorkstationType class:
  • WorkstationType.COMPUTER
  • WorkstationType.GENERAL
  • WorkstationType.PRINTER
  • WorkstationType.FTA
  • Default value is WorkstationType.COMPUTER
    reportingAttribute One of the values exposed by the WorkstationReportingAttribute class
    Default value is WorkstationReportingAttribute.NONREPORTING
    accessMethod Not longer than 12 characters
    Set this field to "r3batch" to handle SAP R/3 jobs
    zosAttributes See WorkstationZOSAttributes for constraints on this field
    workstationAvailabilityIntervals A list of WorkstationAvailabilityInterval objects
    See WorkstationAvailabilityInterval for constraints on this field
    os N/A
    timeZone N/A
    nodeName N/A
    securityLevel N/A
    behindFirewall N/A
    tcpPort N/A
    sslPort N/A
    domainKey N/A
    autoLink N/A
    fullStatus N/A
    server N/A
    isHostedByMaster N/A
    hostWorkstationKey N/A

    See Also:
    FlowTarget, WorkstationType, OperatingSystem, SecurityLevel, WorkstationReportingAttribute, WorkstationZOSAttributes, com.ibm.tws.objects.types.WorkstationAvailabilityInterval, Serialized Form

    Field Summary
    static java.lang.String COPYRIGHT
              Copyright.
     
    Constructor Summary
    Workstation()
              Creates an empty Workstation.
    Workstation(WorkstationHeader workstationHeader)
              Creates a Workstation with the specified header.
     
    Method Summary
     boolean equals(java.lang.Object object)
              Returns true if all fields of this Workstation object are equal to those of the given one.
     java.lang.String getAccessMethod()
              Returns the workstation access method (XA only).
     boolean getAutoLink()
              Returns the workstation autoLink property.
     Identifier getDomainId()
              Returns the identifier of the domain to which the workstation is associated.
     DomainKey getDomainKey()
              Returns the key of the domain to which the workstation is associated.
     Identifier getHostWorkstationId()
              Returns the identifier of the host workstation, if other than the master domain manager (XA only).
     FlowTargetKey getHostWorkstationKey()
              Returns the key of the host workstation, if other than the master domain manager (XA only).
     java.lang.String getNodeName()
              Returns the workstation node name.
     OperatingSystem getOs()
              Returns the workstation operating system.
     WorkstationReportingAttribute getReportingAttribute()
              Returns the workstation reporting attribute.
     SecurityLevel getSecurityLevel()
              Returns the workstation security level.
     char getServer()
              Returns the workstation server code.
     int getSslPort()
              Returns the workstation SSL port.
     int getTcpPort()
              Returns the workstation TCP port.
     java.lang.String getTimeZone()
              Returns the workstation timezone.
     WorkstationType getType()
              Returns the workstation type.
     java.util.List getWorkstationAvailabilityIntervals()
              Returns a reference to the list of workstation availability intervals.
     WorkstationZOSAttributes getZosAttributes()
              Returns the workstation zOS attributes.
     int hashCode()
              Returns a hash code for this Workstation object.
     boolean isAutomation()
              Returns true if the workstation is a system automation type.
     boolean isBehindFirewall()
              Returns true if the workstation is behind a firewall.
     boolean isFullStatus()
              Returns true if the workstation is a full status one.
     boolean isHostedByMaster()
              Returns true if the host workstation is the master domain manager (XA only).
     void setAccessMethod(java.lang.String value)
              Sets the workstation access method (XA only).
     void setAutoLink(boolean value)
              Sets the workstation autoLink property.
     void setAutomation(boolean value)
              Sets the property used to decide if the workstation is a system automation type.
     void setBehindFirewall(boolean value)
              Sets the property used to decide if the workstation is behind a firewall.
     void setDomainId(Identifier identifier)
              Sets the identifier of the domain to which the workstation is associated.
     void setDomainKey(DomainKey key)
              Sets the key of the domain to which the workstation is associated.
     void setFullStatus(boolean value)
              Sets the property used to decide if the workstation is a full status one.
     void setHostedByMaster(boolean value)
              Sets the property used to decide if the host workstation is the master domain manager (XA only).
     void setHostWorkstationId(Identifier identifier)
              Sets the identifier of the host workstation, if other than the master domain manager (XA only).
     void setHostWorkstationKey(FlowTargetKey key)
              Sets the key of the host workstation, if other than the master domain manager (XA only).
     void setNodeName(java.lang.String value)
              Sets the workstation node name.
     void setOs(OperatingSystem value)
              Sets the workstation operating system.
     void setReportingAttribute(WorkstationReportingAttribute value)
              Sets the workstation reporting attribute.
     void setSecurityLevel(SecurityLevel value)
              Sets the workstation security level.
     void setServer(char c)
              Sets the workstation server code.
     void setSslPort(int value)
              Sets the workstation SSL port.
     void setTcpPort(int value)
              Sets the workstation TCP port.
     void setTimeZone(java.lang.String value)
              Sets the workstation timezone.
     void setType(WorkstationType value)
              Sets the workstation type.
     void setZosAttributes(WorkstationZOSAttributes attributes)
              Sets the workstation zOS attributes.
     java.lang.String toString()
              Returns a string representation of this Workstation object.
     
    Methods inherited from class com.ibm.tws.objects.model.FlowTarget
    getDescription, getHeader, getId, getIncludeInPlan, getKey, getLockData, getModifyData, getName, getObjectHeader, getObjectKey, setDescription, setHeader, setId, setIncludeInPlan, setKey, setLockData, setModifyData, setName
     
    Methods inherited from class java.lang.Object
    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
     

    Field Detail

    COPYRIGHT

    public static final java.lang.String COPYRIGHT
    Copyright.

    Constructor Detail

    Workstation

    public Workstation()
    Creates an empty Workstation.


    Workstation

    public Workstation(WorkstationHeader workstationHeader)
    Creates a Workstation with the specified header.

    Parameters:
    workstationHeader - The workstation header.
    Method Detail

    getType

    public WorkstationType getType()
    Returns the workstation type.

    Returns:
    The workstation type.

    getOs

    public OperatingSystem getOs()
    Returns the workstation operating system.

    Returns:
    The workstation operating system.

    getTimeZone

    public java.lang.String getTimeZone()
    Returns the workstation timezone.

    Returns:
    The workstation timezone.

    getNodeName

    public java.lang.String getNodeName()
    Returns the workstation node name.

    Returns:
    The workstation node name.

    getSecurityLevel

    public SecurityLevel getSecurityLevel()
    Returns the workstation security level.

    Returns:
    The workstation security level.

    isBehindFirewall

    public boolean isBehindFirewall()
    Returns true if the workstation is behind a firewall.

    Returns:
    True if the workstation is behind a firewall.

    getSslPort

    public int getSslPort()
    Returns the workstation SSL port.

    Returns:
    The workstation SSL port.

    getTcpPort

    public int getTcpPort()
    Returns the workstation TCP port.

    Returns:
    The workstation TCP port.

    getDomainKey

    public DomainKey getDomainKey()
    Returns the key of the domain to which the workstation is associated.

    Returns:
    The key of the domain to which the workstation is associated.

    getReportingAttribute

    public WorkstationReportingAttribute getReportingAttribute()
    Returns the workstation reporting attribute. This is valid only for a z/OS workstation.

    Returns:
    The workstation reporting attribute.

    getAutoLink

    public boolean getAutoLink()
    Returns the workstation autoLink property.

    Returns:
    The workstation autoLink property.

    isFullStatus

    public boolean isFullStatus()
    Returns true if the workstation is a full status one.

    Returns:
    True if the workstation is a full status one.

    getServer

    public char getServer()
    Returns the workstation server code.

    Returns:
    The workstation server code.

    getAccessMethod

    public java.lang.String getAccessMethod()
    Returns the workstation access method (XA only).

    Returns:
    The workstation access method (XA only).

    getDomainId

    public Identifier getDomainId()
    Returns the identifier of the domain to which the workstation is associated.

    Returns:
    The identifier of the domain to which the workstation is associated.

    isHostedByMaster

    public boolean isHostedByMaster()
    Returns true if the host workstation is the master domain manager (XA only).

    Returns:
    True if the host workstation is the master domain manager (XA only).

    getHostWorkstationId

    public Identifier getHostWorkstationId()
    Returns the identifier of the host workstation, if other than the master domain manager (XA only).

    Returns:
    The identifier of the host workstation, if other than the master domain manager (XA only).

    getHostWorkstationKey

    public FlowTargetKey getHostWorkstationKey()
    Returns the key of the host workstation, if other than the master domain manager (XA only).

    Returns:
    The key of the host workstation, if other than the master domain manager (XA only).

    getWorkstationAvailabilityIntervals

    public java.util.List getWorkstationAvailabilityIntervals()
    Returns a reference to the list of workstation availability intervals.

    Returns:
    A reference to the list of workstation availability intervals.

    getZosAttributes

    public WorkstationZOSAttributes getZosAttributes()
    Returns the workstation zOS attributes.

    Returns:
    The workstation zOS attributes.

    isAutomation

    public boolean isAutomation()
    Returns true if the workstation is a system automation type. This is valid only for a z/OS workstation.

    Returns:
    True if the workstation is a system automation type.

    setType

    public void setType(WorkstationType value)
    Sets the workstation type.

    Parameters:
    value - The workstation type.

    setOs

    public void setOs(OperatingSystem value)
    Sets the workstation operating system.

    Parameters:
    value - The workstation operating system.

    setTimeZone

    public void setTimeZone(java.lang.String value)
    Sets the workstation timezone.

    Parameters:
    value - The workstation timezone.

    setNodeName

    public void setNodeName(java.lang.String value)
    Sets the workstation node name.

    Parameters:
    value - The workstation node name.

    setSecurityLevel

    public void setSecurityLevel(SecurityLevel value)
    Sets the workstation security level.

    Parameters:
    value - The workstation security level.

    setBehindFirewall

    public void setBehindFirewall(boolean value)
    Sets the property used to decide if the workstation is behind a firewall.

    Parameters:
    value - True if the workstation is behind a firewall.

    setSslPort

    public void setSslPort(int value)
    Sets the workstation SSL port.

    Parameters:
    value - The workstation SSL port.

    setTcpPort

    public void setTcpPort(int value)
    Sets the workstation TCP port.

    Parameters:
    value - The workstation TCP port.

    setDomainKey

    public void setDomainKey(DomainKey key)
    Sets the key of the domain to which the workstation is associated.

    Parameters:
    key - The key of the domain to which the workstation is associated.

    setReportingAttribute

    public void setReportingAttribute(WorkstationReportingAttribute value)
    Sets the workstation reporting attribute. This is valid only for a z/OS workstation.

    Parameters:
    value - The workstation reporting attribute.

    setAutoLink

    public void setAutoLink(boolean value)
    Sets the workstation autoLink property.

    Parameters:
    value - The workstation autoLink property.

    setFullStatus

    public void setFullStatus(boolean value)
    Sets the property used to decide if the workstation is a full status one.

    Parameters:
    value - True if the workstation is a full status one.

    setServer

    public void setServer(char c)
    Sets the workstation server code.

    Parameters:
    c - The workstation server code.

    setAccessMethod

    public void setAccessMethod(java.lang.String value)
    Sets the workstation access method (XA only).

    Parameters:
    value - The workstation access method (XA only).

    setDomainId

    public void setDomainId(Identifier identifier)
    Sets the identifier of the domain to which the workstation is associated.

    Parameters:
    identifier - The identifier of the domain to which the workstation is associated.

    setHostedByMaster

    public void setHostedByMaster(boolean value)
    Sets the property used to decide if the host workstation is the master domain manager (XA only).

    Parameters:
    value - True if the host workstation is the master domain manager (XA only).

    setHostWorkstationId

    public void setHostWorkstationId(Identifier identifier)
    Sets the identifier of the host workstation, if other than the master domain manager (XA only).

    Parameters:
    identifier - The identifier of the host workstation, if other than the master domain manager (XA only).

    setHostWorkstationKey

    public void setHostWorkstationKey(FlowTargetKey key)
    Sets the key of the host workstation, if other than the master domain manager (XA only).

    Parameters:
    key - The key of the host workstation, if other than the master domain manager (XA only).

    setZosAttributes

    public void setZosAttributes(WorkstationZOSAttributes attributes)
    Sets the workstation zOS attributes.

    Parameters:
    attributes - The workstation zOS attributes.

    setAutomation

    public void setAutomation(boolean value)
    Sets the property used to decide if the workstation is a system automation type. This is valid only for a z/OS workstation.

    Parameters:
    value - True if the workstation is a system automation type.

    equals

    public boolean equals(java.lang.Object object)
    Returns true if all fields of this Workstation object are equal to those of the given one.

    Overrides:
    equals in class FlowTarget
    Parameters:
    object - The object to be compared with this one.
    Returns:
    True if this object equals to the given one.

    hashCode

    public int hashCode()
    Returns a hash code for this Workstation object.

    Overrides:
    hashCode in class FlowTarget
    Returns:
    The object's hash code.

    toString

    public java.lang.String toString()
    Returns a string representation of this Workstation object.

    Overrides:
    toString in class FlowTarget
    Returns:
    A text string including all Workstation fields.


    Copyright © 2005 IBM All Rights Reserved.