Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client.web

Class RewriteRule

java.lang.Object

com.aoindustries.aoserv.client.AOServObject<K,T>

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

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

com.aoindustries.aoserv.client.web.RewriteRule

All Implemented Interfaces:

Streamable, StreamReadable, StreamWritable, Row, AOServReadable, AOServStreamable, AOServWritable, SingleTableObject<Integer,RewriteRule>

public final class RewriteRule
extends CachedObjectIntegerKey<RewriteRule>

Each VirtualHost may have RewriteRule configurations attached to it.

Author:

AO Industries, Inc.

See Also:

VirtualHost

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
RewriteRule()

Method Summary

Modifier and Type	Method	Description
String	getApacheDirective(String dollarVariable)	Gets the Apache directive for this RewriteRule.
protected Object	getColumnImpl(int i)
String	getComment()	Gets an optional comment describing the rule.
String	getFlags()	Gets the RewriteRule Flags.
int	getId()
String	getPattern()
short	getSortOrder()
String	getSubstitution()
Table.TableID	getTableID()
VirtualHost	getVirtualHost()
int	getVirtualHost_id()
boolean	hasFlag(String flag)	Case-insensitive check if contains the given flag.
boolean	hasFlag(String... flags)	Case-insensitive check if contains any of the given flags.
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 Detail

RewriteRule

public RewriteRule()

Method Detail

getColumnImpl

protected Object getColumnImpl(int i)

Specified by:

getColumnImpl in class AOServObject<Integer,RewriteRule>

getId

public int getId()

getVirtualHost_id

public int getVirtualHost_id()

getVirtualHost

public VirtualHost getVirtualHost()
                           throws SQLException,
                                  IOException

Throws:

SQLException

IOException

getSortOrder

public short getSortOrder()

getPattern

public String getPattern()

getSubstitution

public String getSubstitution()

getFlags

public String getFlags()

Gets the RewriteRule Flags.

Returns:

The flags or null when none.

See Also:

hasFlag(java.lang.String), hasFlag(java.lang.String...)

hasFlag

public boolean hasFlag(String flag)

Case-insensitive check if contains the given flag.

See Also:

getFlags(), hasFlag(java.lang.String...)

hasFlag

public boolean hasFlag(String... flags)

Case-insensitive check if contains any of the given flags.

See Also:

getFlags(), hasFlag(java.lang.String)

getComment

public String getComment()

Gets an optional comment describing the rule.

getTableID

public Table.TableID getTableID()

Specified by:

getTableID in class AOServObject<Integer,RewriteRule>

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,RewriteRule>

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,RewriteRule>

Throws:

IOException

getApacheDirective

public String getApacheDirective(String dollarVariable)

Gets the Apache directive for this RewriteRule.

toStringImpl

public String toStringImpl()

Description copied from class: AOServObject

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<RewriteRule>

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,RewriteRule>

Throws:

IOException