Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client.web

Class Location

java.lang.Object

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

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

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

com.aoindustries.aoserv.client.web.Location

All Implemented Interfaces:

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

public final class Location
extends CachedObjectIntegerKey<Location>
implements Removable

TODO: Make the authentication aspect optional since this now has an optional handler.

Author:

AO Industries, Inc.

See Also:

• Site

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Location.Handler	The set of expected handlers.

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
Location()	Deprecated, for removal: This API element is subject to removal in a future version. Only required for implementation, do not use directly.

Method Summary

Modifier and Type	Method	Description
PosixPath	getAuthGroupFile()
String	getAuthName()
PosixPath	getAuthUserFile()
List<CannotRemoveReason<?>>	getCannotRemoveReasons()	Lists the reasons an object may not be removed.
protected Object	getColumnImpl(int i)
String	getHandler()	Gets the optional handler for SetHandler.
Site	getHttpdSite()
boolean	getIsRegularExpression()
String	getPath()
String	getRequire()
Table.TableId	getTableId()
void	init(ResultSet result)	Initializes this object from the raw database contents.
void	read(StreamableInput in, AoservProtocol.Version protocolVersion)
void	remove()	Removes this object, and all dependant objects, from the system.
void	setAttributes(String path, boolean isRegularExpression, String authName, PosixPath authGroupFile, PosixPath authUserFile, String require, String handler)
String	toStringImpl()	AoservObject.toString() implementation that is allowed to throw exceptions.
static String	validateAuthGroupFile(PosixPath authGroupFile)
static String	validateAuthName(String authName)
static String	validateAuthUserFile(PosixPath authUserFile)
static String	validatePath(String path)
static String	validateRequire(String require)
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

Location

@Deprecated(forRemoval=true)
public Location()

Deprecated, for removal: This API element is subject to removal in a future version.

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

validatePath

public static String validatePath(String path)

validateAuthName

public static String validateAuthName(String authName)

validateAuthGroupFile

public static String validateAuthGroupFile(PosixPath authGroupFile)

validateAuthUserFile

public static String validateAuthUserFile(PosixPath authUserFile)

validateRequire

public static String validateRequire(String require)

getCannotRemoveReasons

public List<CannotRemoveReason<?>> getCannotRemoveReasons()

Description copied from interface: Removable

Lists the reasons an object may not be removed.

Specified by:

getCannotRemoveReasons in interface Removable

Returns:

an empty List<CannotRemoveReason> if this object may be removed, or a list of descriptions

getColumnImpl

protected Object getColumnImpl(int i)

Specified by:

getColumnImpl in class AoservObject<Integer,Location>

getHttpdSite

public Site getHttpdSite()
                  throws SQLException,
IOException

Throws:

SQLException

IOException

getPath

public String getPath()

getIsRegularExpression

public boolean getIsRegularExpression()

getAuthName

public String getAuthName()

getAuthGroupFile

public PosixPath getAuthGroupFile()

getAuthUserFile

public PosixPath getAuthUserFile()

getRequire

public String getRequire()

getHandler

public String getHandler()

Gets the optional handler for SetHandler. May be one of the values in Location.Handler or any other value added in the future.

getTableId

public Table.TableId getTableId()

Specified by:

getTableId in class AoservObject<Integer,Location>

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

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

Throws:

IOException

remove

public void remove()
            throws IOException,
SQLException

Description copied from interface: Removable

Removes this object, and all dependant objects, from the system.

Specified by:

remove in interface Removable

Throws:

IOException

SQLException

setAttributes

public void setAttributes(String path,
 boolean isRegularExpression,
 String authName,
 PosixPath authGroupFile,
 PosixPath authUserFile,
 String require,
 String handler)
                   throws IOException,
SQLException

Throws:

IOException

SQLException

toStringImpl

public String toStringImpl()
                    throws SQLException,
IOException

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

Throws:

SQLException

IOException

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

Throws:

IOException