jain.protocol.ip.sip.header
Class OrganizationHeader

java.lang.Object
  |
  +--jain.protocol.ip.sip.header.Header
        |
        +--jain.protocol.ip.sip.header.RequestHeader
              |
              +--jain.protocol.ip.sip.header.OrganizationHeader

public final class OrganizationHeader

extends RequestHeader

This class represents the Organization general-header. The OrganizationHeader conveys the name of the organization to which the entity issuing the RequestMessage or ResponseMessage belongs. It may also be inserted by proxies at the boundary of an organization. It may be used by client software to filter calls.

Version:

0.6

Field Summary

static java.lang.String

token Token of OrganizationHeader

Fields inherited from class jain.protocol.ip.sip.header.Header

ENTITY_HEADER, GENERAL_HEADER, REQUEST_HEADER, RESPONSE_HEADER

Constructor Summary

OrganizationHeader(java.lang.String organization)
Creates an OrganizationHeader based on given organization

Method Summary

java.lang.Object	clone() Creates and returns a copy of OrganizationHeader
boolean	equals(OrganizationHeader organizationHeader) Indicates whether some other OrganizationHeader is "equal to" this one
java.lang.String	getOrganization() Gets organization of OrganizationHeader
java.lang.String	getValue() Gets value of OrganizationHeader
void	setOrganization(java.lang.String organization) Sets organization of OrganizationHeader

Methods inherited from class jain.protocol.ip.sip.header.Header

equals, getHeaderType, getToken, setValue, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

token

public static final java.lang.String token

Token of OrganizationHeader

Constructor Detail

OrganizationHeader

public OrganizationHeader(java.lang.String organization)
                   throws java.lang.IllegalArgumentException

Creates an OrganizationHeader based on given organization

Parameters:

organization - organization

Throws:

java.lang.IllegalArgumentException - if organization is null or zero-length

Method Detail

getOrganization

public java.lang.String getOrganization()

Gets organization of OrganizationHeader

Returns:

organization of OrganizationHeader

setOrganization

public void setOrganization(java.lang.String organization)
                     throws java.lang.IllegalArgumentException

Sets organization of OrganizationHeader

Parameters:

organization - organization

Throws:

java.lang.IllegalArgumentException - if organization is null or zero-length

getValue

public java.lang.String getValue()

Gets value of OrganizationHeader

Overrides:

getValue in class Header

Returns:

value of OrganizationHeader

clone

public java.lang.Object clone()

Creates and returns a copy of OrganizationHeader

Overrides:

clone in class Header

equals

public boolean equals(OrganizationHeader organizationHeader)

Indicates whether some other OrganizationHeader is "equal to" this one

Parameters:

organizationHeader - the OrganizationHeader with which to compare