org.vfny.geoserver.config
Class ContactConfig

java.lang.Object
  org.vfny.geoserver.config.ContactConfig

public class ContactConfig

extends java.lang.Object

Represents a Contact (or Party).

This is used by GeoServer to represent a contact person or organization associated with the Service.

The configuration file represents Contact information using the following XML fragment (at the time of writing):

 {ContactInformation}
   {ContactPersonPrimary}
     {ContactPerson}Chris Holmes{/ContactPerson}
     {ContactOrganization}TOPP{/ContactOrganization}
   {/ContactPersonPrimary}
   {ContactPosition}Computer Scientist{/ContactPosition}
   {ContactAddress}
     {AddressType}postal{/AddressType}
     {Address}Street addresss here{/Address}
     {City}New York{/City}
     {StateOrProvince}New York{/StateOrProvince}
     {PostCode}0001{/PostCode}
     {Country}USA{/Country}
   {/ContactAddress}
   {ContactVoiceTelephone}+1 301 283-1569{/ContactVoiceTelephone}
   {ContactFacsimileTelephone}+1 301 283-1569{/ContactFacsimileTelephone}
 {/ContactInformation}
 

To communicate with the running GeoServer application, represented by the classes in global, the Contact information will need to be placed into the ContactDTO.

Constructor Summary

ContactConfig()
Default ContactConfig constructor.

ContactConfig(ContactDTO dto)
ContactConfig constructor.

Method Summary

java.lang.String	getAddress() getAddress purpose.
java.lang.String	getAddressCity() getAddressCity purpose.
java.lang.String	getAddressCountry() getAddressCountry purpose.
java.lang.String	getAddressPostalCode() getAddressPostalCode purpose.
java.lang.String	getAddressState() getAddressState purpose.
java.lang.String	getAddressType() getAddressType purpose.
java.lang.String	getContactEmail() getContactEmail purpose.
java.lang.String	getContactFacsimile() getContactFacsimile purpose.
java.lang.String	getContactOrganization() getContactOrganization purpose.
java.lang.String	getContactPerson() getContactPerson purpose.
java.lang.String	getContactPosition() getContactPosition purpose.
java.lang.String	getContactVoice() getContactVoice purpose.
void	setAddress(java.lang.String string) setAddress purpose.
void	setAddressCity(java.lang.String string) setAddressCity purpose.
void	setAddressCountry(java.lang.String string) setAddressCountry purpose.
void	setAddressPostalCode(java.lang.String string) setAddressPostalCode purpose.
void	setAddressState(java.lang.String string) setAddressState purpose.
void	setAddressType(java.lang.String string) setAddressType purpose.
void	setContactEmail(java.lang.String string) setContactEmail purpose.
void	setContactFacsimile(java.lang.String string) setContactFacsimile purpose.
void	setContactOrganization(java.lang.String string) setContactOrganization purpose.
void	setContactPerson(java.lang.String string) setContactPerson purpose.
void	setContactPosition(java.lang.String string) setContactPosition purpose.
void	setContactVoice(java.lang.String string) setContactVoice purpose.
ContactDTO	toDTO()
void	update(ContactDTO dto) Update the configuration to reflect the provided Data Transfer Object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ContactConfig

public ContactConfig()

Default ContactConfig constructor.

Creates an empty ContactConfig object which must be setup prior to use.

ContactConfig

public ContactConfig(ContactDTO dto)

ContactConfig constructor.

Creates a copy of the ContactConfig specified, or returns a default ContactConfig when null is provided. None of the data is cloned, as String are stored in a hashtable in memory.

Parameters:

dto - The ContactConfig to create a copy of.

Method Detail

update

public void update(ContactDTO dto)

Update the configuration to reflect the provided Data Transfer Object.

This may be used as a course grained set method, this is the entry point for the live GeoServer application to update the configuration system when a new XML file is loaded.

Parameters:

dto - Data Transfer Object representing Contact Information

Throws:

java.lang.NullPointerException - DOCUMENT ME!

toDTO

public ContactDTO toDTO()

getAddress

public java.lang.String getAddress()

getAddress purpose.

Description ...

Returns:

getAddressCity

public java.lang.String getAddressCity()

getAddressCity purpose.

Description ...

Returns:

getAddressCountry

public java.lang.String getAddressCountry()

getAddressCountry purpose.

Description ...

Returns:

getAddressPostalCode

public java.lang.String getAddressPostalCode()

getAddressPostalCode purpose.

Description ...

Returns:

getAddressState

public java.lang.String getAddressState()

getAddressState purpose.

Description ...

Returns:

getAddressType

public java.lang.String getAddressType()

getAddressType purpose.

Description ...

Returns:

getContactEmail

public java.lang.String getContactEmail()

getContactEmail purpose.

Description ...

Returns:

getContactFacsimile

public java.lang.String getContactFacsimile()

getContactFacsimile purpose.

Description ...

Returns:

getContactOrganization

public java.lang.String getContactOrganization()

getContactOrganization purpose.

Description ...

Returns:

getContactPerson

public java.lang.String getContactPerson()

getContactPerson purpose.

Description ...

Returns:

getContactPosition

public java.lang.String getContactPosition()

getContactPosition purpose.

Description ...

Returns:

getContactVoice

public java.lang.String getContactVoice()

getContactVoice purpose.

Description ...

Returns:

setAddress

public void setAddress(java.lang.String string)

setAddress purpose.

Description ...

Parameters:

string -

setAddressCity

public void setAddressCity(java.lang.String string)

setAddressCity purpose.

Description ...

Parameters:

string -

setAddressCountry

public void setAddressCountry(java.lang.String string)

setAddressCountry purpose.

Description ...

Parameters:

string -

setAddressPostalCode

public void setAddressPostalCode(java.lang.String string)

setAddressPostalCode purpose.

Description ...

Parameters:

string -

setAddressState

public void setAddressState(java.lang.String string)

setAddressState purpose.

Description ...

Parameters:

string -

setAddressType

public void setAddressType(java.lang.String string)

setAddressType purpose.

Description ...

Parameters:

string -

setContactEmail

public void setContactEmail(java.lang.String string)

setContactEmail purpose.

Description ...

Parameters:

string -

setContactFacsimile

public void setContactFacsimile(java.lang.String string)

setContactFacsimile purpose.

Description ...

Parameters:

string -

setContactOrganization

public void setContactOrganization(java.lang.String string)

setContactOrganization purpose.

Description ...

Parameters:

string -

setContactPerson

public void setContactPerson(java.lang.String string)

setContactPerson purpose.

Description ...

Parameters:

string -

setContactPosition

public void setContactPosition(java.lang.String string)

setContactPosition purpose.

Description ...

Parameters:

string -

setContactVoice

public void setContactVoice(java.lang.String string)

setContactVoice purpose.

Description ...

Parameters:

string -