Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client.web

Class Header

java.lang.Object

com.aoindustries.aoserv.client.AoservObject<Integer,Header>

com.aoindustries.aoserv.client.CachedObject<Integer,Header>

com.aoindustries.aoserv.client.CachedObjectIntegerKey<Header>

com.aoindustries.aoserv.client.web.Header

All Implemented Interfaces:

Streamable, StreamReadable, StreamWritable, Row, AoservReadable, AoservStreamable, AoservWritable, SingleTableObject<Integer,Header>

public final class Header
extends CachedObjectIntegerKey<Header>

Each VirtualHost may have header configurations attached to it. See mod_headers - Apache HTTP Server Version 2.4.

Author:

AO Industries, Inc.

See Also:

• VirtualHost

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Header.Type

Field Summary

Fields inherited from class com.aoindustries.aoserv.client.CachedObjectIntegerKey

pkey

Fields inherited from class com.aoindustries.aoserv.client.CachedObject

table

Fields inherited from class com.aoindustries.aoserv.client.AoservObject

USE_ARRAY_OF_DOMAIN, USE_SQL_DATA, USE_SQL_DATA_WRITE

Constructor Summary

Constructors

Constructor	Description
Header()	Deprecated. Only required for implementation, do not use directly.

Method Summary

Modifier and Type	Method	Description
String	getAction()	Gets the action.
boolean	getAlways()	The condition is either "onsuccess" (default, can be omitted) or "always".
String	getApacheDirective(String dollarVariable)	Gets the Apache directive for this header.
protected Object	getColumnImpl(int i)
String	getComment()
String	getHeader()	The header name, without any final colon.
VirtualHost	getHttpdSiteBind()
String	getReplacement()	Gets the replacement.
short	getSortOrder()
Table.TableId	getTableId()
Header.Type	getType()
String	getValue()	Gets the value.
String	getWhen()	Optional control over when is this header directive is applied.
void	init(ResultSet result)	Initializes this object from the raw database contents.
void	read(StreamableInput in, AoservProtocol.Version protocolVersion)
String	toStringImpl()	AoservObject.toString() implementation that is allowed to throw exceptions.
void	write(StreamableOutput out, AoservProtocol.Version protocolVersion)

Methods inherited from class com.aoindustries.aoserv.client.CachedObjectIntegerKey

equals, getKey, getPkey, hashCode

Methods inherited from class com.aoindustries.aoserv.client.CachedObject

getTable, setTable

Methods inherited from class com.aoindustries.aoserv.client.AoservObject

compare, compare, compare, compare, compareIgnoreCaseConsistentWithEquals, compareTo, compareTo, compareTo, getAccountingCode, getColumn, getColumns, getColumns, getDomainLabel, getDomainLabels, getDomainName, getDto, getEmail, getGecos, getGroupId, getHashedKey, getHashedPassword, getHostname, getInetAddress, getLinuxId, getLinuxUserName, getMacAddress, getMysqlDatabaseName, getMysqlServerName, getMysqlUserName, getPort, getPostgresDatabaseName, getPostgresServerName, getPostgresUserId, getTableSchema, getTimeMillis, getTimeMillis, getUnixPath, getUserId, read, toString, write

Methods inherited from class java.lang.Object

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

Constructor Details

Header

@Deprecated
public Header()

Deprecated.

Only required for implementation, do not use directly.

See Also:

• init(java.sql.ResultSet)
• read(com.aoapps.hodgepodge.io.stream.StreamableInput, com.aoindustries.aoserv.client.schema.AoservProtocol.Version)

Method Details

getColumnImpl

protected Object getColumnImpl(int i)

Specified by:

getColumnImpl in class AoservObject<Integer,Header>

getHttpdSiteBind

public VirtualHost getHttpdSiteBind()
                             throws SQLException,
IOException

Throws:

SQLException

IOException

getSortOrder

public short getSortOrder()

getType

public Header.Type getType()

getAlways

public boolean getAlways()

The condition is either "onsuccess" (default, can be omitted) or "always". We model this as a simple flag to enable "always". Header.Type.Header-only.

getAction

public String getAction()

Gets the action. One of (with potentially more supported in the future):

• "add"
• "append"
• "echo" (Header.Type.Header-only)
• "edit"
• "edit*"
• "merge"
• "set"
• "setifempty"
• "unset"
• "note" (Header.Type.Header-only)

getHeader

public String getHeader()

The header name, without any final colon.

In the Apache directive, the final colon is optional. We choose to not allow the final colon to avoid any unnecessary ambiguities.

getValue

public String getValue()

Gets the value. As used by any of the following actions:

• "add"
• "append"
• "edit"
• "edit*"
• "merge"
• "set"
• "setifempty"
• "note" (Header.Type.Header-only)

The following actions do not have any value:

• "echo" (Header.Type.Header-only)
• "unset"

getReplacement

public String getReplacement()

Gets the replacement. Only used by the following actions:

• "edit"
• "edit*"

getWhen

public String getWhen()

Optional control over when is this header directive is applied. Will be one of (with potentially more supported in the future):

• "early"
• "env=*"
• "expr=*"

getComment

public String getComment()

getTableId

public Table.TableId getTableId()

Specified by:

getTableId in class AoservObject<Integer,Header>

init

public void init(ResultSet result)
          throws SQLException

Description copied from class: AoservObject

Initializes this object from the raw database contents.

Specified by:

init in class AoservObject<Integer,Header>

Parameters:

result - the ResultSet containing the row to copy into this object

Throws:

SQLException

read

public void read(StreamableInput in,
 AoservProtocol.Version protocolVersion)
          throws IOException

Specified by:

read in interface AoservReadable

Specified by:

read in interface AoservStreamable

Specified by:

read in class AoservObject<Integer,Header>

Throws:

IOException

getApacheDirective

public String getApacheDirective(String dollarVariable)

Gets the Apache directive for this header.

toStringImpl

public String toStringImpl()

AoservObject.toString() implementation that is allowed to throw exceptions.

Implementation Note:
This default implementation calls AoservObject.toString() on the key (from AoservObject.getKey()). When the key is null, uses the default implementation from Object.toString().

Overrides:

toStringImpl in class CachedObjectIntegerKey<Header>

See Also:

• getApacheDirective(java.lang.String)
• ApacheEscape.DEFAULT_DOLLAR_VARIABLE

write

public void write(StreamableOutput out,
 AoservProtocol.Version protocolVersion)
           throws IOException

Specified by:

write in interface AoservStreamable

Specified by:

write in interface AoservWritable

Specified by:

write in class AoservObject<Integer,Header>

Throws:

IOException