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>
TODO: Make the authentication aspect optional since this now has an optional handler.
- Author:
- AO Industries, Inc.
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
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
ConstructorsConstructorDescriptionLocation()
Deprecated.Only required for implementation, do not use directly. -
Method Summary
Modifier and TypeMethodDescriptionLists the reasons an object may not be removed.protected Object
getColumnImpl
(int i) Gets the optional handler forSetHandler
.boolean
getPath()
void
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) 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
-
Constructor Details
-
Location
Deprecated.Only required for implementation, do not use directly.- See Also:
-
-
Method Details
-
validatePath
-
validateAuthName
-
validateAuthGroupFile
-
validateAuthUserFile
-
validateRequire
-
getCannotRemoveReasons
Description copied from interface:Removable
Lists the reasons an object may not be removed.- Specified by:
getCannotRemoveReasons
in interfaceRemovable
- Returns:
- an empty
List<CannotRemoveReason>
if this object may be removed, or a list of descriptions
-
getColumnImpl
- Specified by:
getColumnImpl
in classAoservObject<Integer,
Location>
-
getHttpdSite
- Throws:
SQLException
IOException
-
getPath
-
getIsRegularExpression
public boolean getIsRegularExpression() -
getAuthName
-
getAuthGroupFile
-
getAuthUserFile
-
getRequire
-
getHandler
Gets the optional handler forSetHandler
. May be one of the values inLocation.Handler
or any other value added in the future. -
getTableId
- Specified by:
getTableId
in classAoservObject<Integer,
Location>
-
init
Description copied from class:AoservObject
Initializes this object from the raw database contents.- Specified by:
init
in classAoservObject<Integer,
Location> - Parameters:
result
- theResultSet
containing the row to copy into this object- Throws:
SQLException
-
read
- Specified by:
read
in interfaceAoservReadable
- Specified by:
read
in interfaceAoservStreamable
- Specified by:
read
in classAoservObject<Integer,
Location> - Throws:
IOException
-
remove
Description copied from interface:Removable
Removes this object, and all dependant objects, from the system.- Specified by:
remove
in interfaceRemovable
- 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
Description copied from class:AoservObject
AoservObject.toString()
implementation that is allowed to throw exceptions.Implementation Note:
This default implementation callsAoservObject.toString()
on the key (fromAoservObject.getKey()
). When the key isnull
, uses the default implementation fromObject.toString()
.- Overrides:
toStringImpl
in classCachedObjectIntegerKey<Location>
- Throws:
SQLException
IOException
-
write
- Specified by:
write
in interfaceAoservStreamable
- Specified by:
write
in interfaceAoservWritable
- Specified by:
write
in classAoservObject<Integer,
Location> - Throws:
IOException
-