org.liquidsite.core.content
Class Host

java.lang.Object
  org.liquidsite.core.content.PersistentObject
      org.liquidsite.core.content.Host

public class Host

extends PersistentObject

A web site host.

Field Summary

static java.lang.String

NAME_CHARS The permitted host name characters.

Fields inherited from class org.liquidsite.core.content.PersistentObject

BINDERS, LOWER_CASE, NUMBERS, UPPER_CASE

Constructor Summary

Host(ContentManager manager, Domain domain, java.lang.String name)
Creates a new host with default values.

Method Summary

protected void	doDelete(DataSource src, User user) Deletes the object data from the database.
protected void	doInsert(DataSource src, User user, boolean restore) Inserts the object data into the database.
protected void	doUpdate(DataSource src, User user) Updates the object data in the database.
protected void	doValidate() Validates the object data before writing to the database.
boolean	equals(java.lang.Object obj) Checks if this host equals another object.
java.lang.String	getDescription() Returns the host description.
Domain	getDomain() Returns the host domain.
java.lang.String	getDomainName() Returns the host domain name.
java.lang.String	getName() Returns the unique host name.
void	setDescription(java.lang.String description) Sets the host description.
java.lang.String	toString() Returns a string representation of this object.

Methods inherited from class org.liquidsite.core.content.PersistentObject

decodeMap, delete, delete, encodeMap, getContentManager, hasAdminAccess, hasPublishAccess, hasReadAccess, hasWriteAccess, isPersistent, restore, restore, save, save, validateChars, validateSize

Methods inherited from class java.lang.Object

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

Field Detail

NAME_CHARS

public static final java.lang.String NAME_CHARS

The permitted host name characters.

See Also:

Constant Field Values

Constructor Detail

Host

public Host(ContentManager manager,
            Domain domain,
            java.lang.String name)

Creates a new host with default values.

Parameters:

manager - the content manager to use

domain - the domain

name - the host name

Method Detail

equals

public boolean equals(java.lang.Object obj)

Checks if this host equals another object. This method will only return true if the other object is a host with the same name.

Parameters:

obj - the object to compare with

Returns:

true if the other object is an identical host, or false otherwise

toString

public java.lang.String toString()

Returns a string representation of this object.

Returns:

a string representation of this object

getDomain

public Domain getDomain()
                 throws ContentException

Returns the host domain.

Returns:

the host domain

Throws:

ContentException - if no content manager is available

getDomainName

public java.lang.String getDomainName()

Returns the host domain name.

Returns:

the host domain name

getName

public java.lang.String getName()

Returns the unique host name.

Returns:

the unique host name

getDescription

public java.lang.String getDescription()

Returns the host description.

Returns:

the host description

setDescription

public void setDescription(java.lang.String description)

Sets the host description.

Parameters:

description - the new description

doValidate

protected void doValidate()
                   throws ContentException

Validates the object data before writing to the database.

Specified by:

doValidate in class PersistentObject

Throws:

ContentException - if the object data wasn't valid

doInsert

protected void doInsert(DataSource src,
                        User user,
                        boolean restore)
                 throws ContentException

Inserts the object data into the database. If the restore flag is set, no automatic changes should be made to the data before writing to the database.

Specified by:

doInsert in class PersistentObject

Parameters:

src - the data source to use

user - the user performing the operation

restore - the restore flag

Throws:

ContentException - if the database couldn't be accessed properly

doUpdate

protected void doUpdate(DataSource src,
                        User user)
                 throws ContentException

Updates the object data in the database.

Specified by:

doUpdate in class PersistentObject

Parameters:

src - the data source to use

user - the user performing the operation

Throws:

ContentException - if the database couldn't be accessed properly

doDelete

protected void doDelete(DataSource src,
                        User user)
                 throws ContentException

Deletes the object data from the database.

Specified by:

doDelete in class PersistentObject

Parameters:

src - the data source to use

user - the user performing the operation

Throws:

ContentException - if the database couldn't be accessed properly