Package org.apache.hadoop.registry.server.services

Class RegistryAdminService

java.lang.Object

org.apache.hadoop.service.AbstractService

org.apache.hadoop.service.CompositeService

org.apache.hadoop.registry.client.impl.zk.CuratorService

org.apache.hadoop.registry.client.impl.zk.RegistryOperationsService

org.apache.hadoop.registry.server.services.RegistryAdminService

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, RegistryConstants, RegistryOperations, RegistryBindingSource, org.apache.hadoop.service.Service

public class RegistryAdminService
extends RegistryOperationsService

Administrator service for the registry. This is the one with permissions to create the base directories and those for users. It also includes support for asynchronous operations, so that zookeeper connectivity problems do not hold up the server code performing the actions. Any action queued via submit(Callable) will be run asynchronously. The createDirAsync(String, List, boolean) is an example of such an an action A key async action is the depth-first tree purge, which supports pluggable policies for deleting entries. The method purge(String, NodeSelector, PurgePolicy, BackgroundCallback) implements the recursive purge operation —the class {{AsyncPurge}} provides the asynchronous scheduling of this.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	RegistryAdminService.AsyncPurge	An async registry purge action taking a selector which decides what to delete
static interface	RegistryAdminService.NodeSelector	Comparator used for purge logic
static class	RegistryAdminService.PurgePolicy	Policy to purge entries

Nested classes/interfaces inherited from class org.apache.hadoop.service.CompositeService

org.apache.hadoop.service.CompositeService.CompositeServiceShutdownHook

Nested classes/interfaces inherited from interface org.apache.hadoop.service.Service

org.apache.hadoop.service.Service.STATE

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.concurrent.ExecutorService	executor	Executor for async operations
static int	USER_HOMEDIR_ACL_PERMISSIONS	The ACL permissions for the user's homedir ACL.

Fields inherited from class org.apache.hadoop.service.CompositeService

STOP_ONLY_STARTED_SERVICES

Fields inherited from interface org.apache.hadoop.registry.client.api.RegistryConstants

DEFAULT_DNS_ENABLED, DEFAULT_DNS_PORT, DEFAULT_DNS_SPLIT_REVERSE_ZONE, DEFAULT_DNSSEC_PRIVATE_KEY_FILE, DEFAULT_REGISTRY_CLIENT_JAAS_CONTEXT, DEFAULT_REGISTRY_SECURE, DEFAULT_REGISTRY_SYSTEM_ACCOUNTS, DEFAULT_REGISTRY_USER_ACCOUNTS, DEFAULT_REGISTRY_ZK_QUORUM, DEFAULT_ZK_CONNECTION_TIMEOUT, DEFAULT_ZK_REGISTRY_ROOT, DEFAULT_ZK_RETRY_CEILING, DEFAULT_ZK_RETRY_INTERVAL, DEFAULT_ZK_RETRY_TIMES, DEFAULT_ZK_SESSION_TIMEOUT, DNS_PREFIX, KEY_DNS_BIND_ADDRESS, KEY_DNS_DOMAIN, KEY_DNS_ENABLED, KEY_DNS_PORT, KEY_DNS_SPLIT_REVERSE_ZONE, KEY_DNS_SPLIT_REVERSE_ZONE_RANGE, KEY_DNS_TTL, KEY_DNS_ZONE_IP_MAX, KEY_DNS_ZONE_IP_MIN, KEY_DNS_ZONE_MASK, KEY_DNS_ZONE_SUBNET, KEY_DNS_ZONES_DIR, KEY_DNSSEC_ENABLED, KEY_DNSSEC_PRIVATE_KEY_FILE, KEY_DNSSEC_PUBLIC_KEY, KEY_REGISTRY_CLIENT_AUTH, KEY_REGISTRY_CLIENT_AUTHENTICATION_ID, KEY_REGISTRY_CLIENT_AUTHENTICATION_PASSWORD, KEY_REGISTRY_CLIENT_JAAS_CONTEXT, KEY_REGISTRY_KERBEROS_REALM, KEY_REGISTRY_SECURE, KEY_REGISTRY_SYSTEM_ACCOUNTS, KEY_REGISTRY_USER_ACCOUNTS, KEY_REGISTRY_ZK_CONNECTION_TIMEOUT, KEY_REGISTRY_ZK_QUORUM, KEY_REGISTRY_ZK_RETRY_CEILING, KEY_REGISTRY_ZK_RETRY_INTERVAL, KEY_REGISTRY_ZK_RETRY_TIMES, KEY_REGISTRY_ZK_ROOT, KEY_REGISTRY_ZK_SESSION_TIMEOUT, MAX_FQDN_LABEL_LENGTH, PATH_SYSTEM_SERVICES, PATH_USER_SERVICES, PATH_USERS, REGISTRY_CLIENT_AUTH_ANONYMOUS, REGISTRY_CLIENT_AUTH_DIGEST, REGISTRY_CLIENT_AUTH_KERBEROS, REGISTRY_CLIENT_AUTH_SIMPLE, REGISTRY_PREFIX, SUBPATH_COMPONENTS, ZK_PREFIX

Constructor Summary

Constructors

Constructor	Description
RegistryAdminService(java.lang.String name)	Construct an instance of the service
RegistryAdminService(java.lang.String name, RegistryBindingSource bindingSource)	construct an instance of the service, using the specified binding source to bond to ZK

Method Summary

Modifier and Type	Method	Description
java.util.List<org.apache.zookeeper.data.ACL>	aclsForUser(java.lang.String username, int perms)	Set up the ACL for the user.
java.util.concurrent.Future<java.lang.Boolean>	createDirAsync(java.lang.String path, java.util.List<org.apache.zookeeper.data.ACL> acls, boolean createParents)	Asynchronous operation to create a directory
void	createRootRegistryPaths()	Create the initial registry paths
protected java.util.concurrent.ExecutorService	getExecutor()	Get the executor
protected java.lang.String	homeDir(java.lang.String username)	Get the path to a user's home dir
java.lang.String	initUserRegistry(java.lang.String username)	Create the home path for a user if it does not exist.
java.util.concurrent.Future<java.lang.Boolean>	initUserRegistryAsync(java.lang.String shortname)	Start an async operation to create the home path for a user if it does not exist
int	purge(java.lang.String path, RegistryAdminService.NodeSelector selector, RegistryAdminService.PurgePolicy purgePolicy, org.apache.curator.framework.api.BackgroundCallback callback)	Recursive operation to purge all matching records under a base path.
protected void	serviceInit(org.apache.hadoop.conf.Configuration conf)	Init operation sets up the system ACLs.
protected void	serviceStart()	Start the service, including creating base directories with permissions
protected void	serviceStop()	Stop the service: halt the executor.
protected void	stopExecutor()	Stop the executor if it is not null.
<V> java.util.concurrent.Future<V>	submit(java.util.concurrent.Callable<V> callable)	Submit a callable
protected void	verifyRealmValidity()	Method to validate the validity of the kerberos realm.

Methods inherited from class org.apache.hadoop.registry.client.impl.zk.RegistryOperationsService

bind, delete, exists, getClientAcls, list, mknode, resolve, stat, validatePath

Methods inherited from class org.apache.hadoop.registry.client.impl.zk.CuratorService

addWriteAccessor, bindingDiagnosticDetails, buildConnectionString, buildSecurityDiagnostics, clearWriteAccessors, createEnsembleProvider, createFullPath, dumpPath, dumpRegistryRobustly, getBindingSource, getRegistrySecurity, instantiateCacheForRegistry, isSecure, maybeCreate, operationFailure, operationFailure, registerPathListener, setKerberosPrincipalAndKeytab, startCache, supplyBindingInformation, toString, zkCreate, zkDelete, zkGetACLS, zkList, zkMkParentPath, zkMkPath, zkPathExists, zkPathMustExist, zkRead, zkSet, zkStat, zkUpdate

Methods inherited from class org.apache.hadoop.service.CompositeService

addIfService, addService, getServices, removeService

Methods inherited from class org.apache.hadoop.service.AbstractService

close, getBlockers, getConfig, getFailureCause, getFailureState, getLifecycleHistory, getName, getServiceState, getStartTime, init, isInState, noteFailure, putBlocker, registerGlobalListener, registerServiceListener, removeBlocker, setConfig, start, stop, unregisterGlobalListener, unregisterServiceListener, waitForServiceToStop

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.hadoop.registry.client.api.RegistryOperations

addWriteAccessor, clearWriteAccessors

Methods inherited from interface org.apache.hadoop.service.Service

close, getBlockers, getConfig, getFailureCause, getFailureState, getLifecycleHistory, getName, getServiceState, getStartTime, init, isInState, registerServiceListener, start, stop, unregisterServiceListener, waitForServiceToStop

Field Detail

USER_HOMEDIR_ACL_PERMISSIONS

public static final int USER_HOMEDIR_ACL_PERMISSIONS

The ACL permissions for the user's homedir ACL.

See Also:

Constant Field Values

executor

protected final java.util.concurrent.ExecutorService executor

Executor for async operations

Constructor Detail

RegistryAdminService

public RegistryAdminService(java.lang.String name)

Construct an instance of the service

Parameters:

name - service name

RegistryAdminService

public RegistryAdminService(java.lang.String name,
                            RegistryBindingSource bindingSource)

construct an instance of the service, using the specified binding source to bond to ZK

Parameters:

name - service name

bindingSource - provider of ZK binding information

Method Detail

serviceStop

protected void serviceStop()
                    throws java.lang.Exception

Stop the service: halt the executor.

Overrides:

serviceStop in class CuratorService

Throws:

java.lang.Exception - exception.

stopExecutor

protected void stopExecutor()

Stop the executor if it is not null. This uses ExecutorService.shutdownNow() and so does not block until they have completed.

getExecutor

protected java.util.concurrent.ExecutorService getExecutor()

Get the executor

Returns:

the executor

submit

public <V> java.util.concurrent.Future<V> submit(java.util.concurrent.Callable<V> callable)

Submit a callable

Type Parameters:

V - type of the final get

Parameters:

callable - callable

Returns:

a future to wait on

createDirAsync

public java.util.concurrent.Future<java.lang.Boolean> createDirAsync(java.lang.String path,
                                                                     java.util.List<org.apache.zookeeper.data.ACL> acls,
                                                                     boolean createParents)
                                                              throws java.io.IOException

Asynchronous operation to create a directory

Parameters:

path - path

acls - ACL list

createParents - flag to indicate parent dirs should be created as needed

Returns:

the future which will indicate whether or not the operation succeeded —and propagate any exceptions

Throws:

java.io.IOException

serviceInit

protected void serviceInit(org.apache.hadoop.conf.Configuration conf)
                    throws java.lang.Exception

Init operation sets up the system ACLs.

Overrides:

serviceInit in class CuratorService

Parameters:

conf - configuration of the service

Throws:

java.lang.Exception

serviceStart

protected void serviceStart()
                     throws java.lang.Exception

Start the service, including creating base directories with permissions

Overrides:

serviceStart in class CuratorService

Throws:

java.lang.Exception

createRootRegistryPaths

@VisibleForTesting
public void createRootRegistryPaths()
                             throws java.io.IOException

Create the initial registry paths

Throws:

java.io.IOException - any failure

homeDir

protected java.lang.String homeDir(java.lang.String username)

Get the path to a user's home dir

Parameters:

username - username

Returns:

a path for services underneath

aclsForUser

public java.util.List<org.apache.zookeeper.data.ACL> aclsForUser(java.lang.String username,
                                                                 int perms)
                                                          throws java.io.IOException

Set up the ACL for the user. Important: this must run client-side as it needs to know the id:pass tuple for a user

Parameters:

username - user name

perms - permissions

Returns:

an ACL list

Throws:

java.io.IOException - ACL creation/parsing problems

initUserRegistryAsync

public java.util.concurrent.Future<java.lang.Boolean> initUserRegistryAsync(java.lang.String shortname)
                                                                     throws java.io.IOException

Start an async operation to create the home path for a user if it does not exist

Parameters:

shortname - username, without any @REALM in kerberos

Returns:

the path created

Throws:

java.io.IOException - any failure while setting up the operation

initUserRegistry

public java.lang.String initUserRegistry(java.lang.String username)
                                  throws java.io.IOException

Create the home path for a user if it does not exist. This uses initUserRegistryAsync(String) and then waits for the result ... the code path is the same as the async operation; this just picks up and relays/converts exceptions

Parameters:

username - username

Returns:

the path created

Throws:

java.io.IOException - any failure

verifyRealmValidity

protected void verifyRealmValidity()
                            throws org.apache.hadoop.service.ServiceStateException

Method to validate the validity of the kerberos realm.

• Insecure: not needed.
• Secure: must have been determined.

Throws:

org.apache.hadoop.service.ServiceStateException

purge

@VisibleForTesting
public int purge(java.lang.String path,
                 RegistryAdminService.NodeSelector selector,
                 RegistryAdminService.PurgePolicy purgePolicy,
                 org.apache.curator.framework.api.BackgroundCallback callback)
          throws java.io.IOException

Recursive operation to purge all matching records under a base path.

1. Uses a depth first search
2. A match is on ID and persistence policy, or, if policy==-1, any match
3. If a record matches then it is deleted without any child searches
4. Deletions will be asynchronous if a callback is provided

The code is designed to be robust against parallel deletions taking place; in such a case it will stop attempting that part of the tree. This avoid the situation of more than 1 purge happening in parallel and one of the purge operations deleteing the node tree above the other.

Parameters:

path - base path

selector - selector for the purge policy

purgePolicy - what to do if there is a matching record with children

callback - optional curator callback

Returns:

the number of delete operations perfomed. As deletes may be for everything under a path, this may be less than the number of records actually deleted

Throws:

java.io.IOException - problems

org.apache.hadoop.fs.PathIsNotEmptyDirectoryException - if an entry cannot be deleted as it has children and the purge policy is FailOnChildren