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

クラス RegistryOperationsService

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

すべての実装されたインタフェース:

Closeable, AutoCloseable, RegistryConstants, RegistryOperations, RegistryBindingSource, Service

直系の既知のサブクラス:

RegistryOperationsClient

@InterfaceAudience.Public
 @InterfaceStability.Evolving
public class RegistryOperationsService
extends org.apache.hadoop.registry.client.impl.zk.CuratorService
implements RegistryOperations

The Registry operations service.

This service implements the RegistryOperations API by mapping the commands to zookeeper operations, and translating results and exceptions back into those specified by the API.

Factory methods should hide the detail that this has been implemented via the CuratorService by returning it cast to that RegistryOperations interface, rather than this implementation class.

フィールドのサマリー

クラスから継承されたフィールド org.apache.hadoop.service.CompositeService

STOP_ONLY_STARTED_SERVICES

インタフェースから継承されたフィールド org.apache.hadoop.registry.client.api.RegistryConstants

DEFAULT_REGISTRY_CLIENT_JAAS_CONTEXT, DEFAULT_REGISTRY_ENABLED, 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, KEY_REGISTRY_CLIENT_AUTH, KEY_REGISTRY_CLIENT_AUTHENTICATION_ID, KEY_REGISTRY_CLIENT_AUTHENTICATION_PASSWORD, KEY_REGISTRY_CLIENT_JAAS_CONTEXT, KEY_REGISTRY_ENABLED, 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, PATH_SYSTEM_SERVICES, PATH_USER_SERVICES, PATH_USERS, REGISTRY_CLIENT_AUTH_ANONYMOUS, REGISTRY_CLIENT_AUTH_DIGEST, REGISTRY_CLIENT_AUTH_KERBEROS, REGISTRY_PREFIX, SUBPATH_COMPONENTS, ZK_PREFIX

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
RegistryOperationsService()
RegistryOperationsService(String name)
RegistryOperationsService(String name, RegistryBindingSource bindingSource)

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	bind(String path, ServiceRecord record, int flags) Bind a path in the registry to a service record
void	delete(String path, boolean recursive) Delete a path.
boolean	exists(String path) Probe for a path existing.
List<org.apache.zookeeper.data.ACL>	getClientAcls() Get the aggregate set of ACLs the client should use to create directories
List<String>	list(String path) List all entries under a registry path, returning the relative names of the entries.
boolean	mknode(String path, boolean createParents) Create a path.
ServiceRecord	resolve(String path) Resolve the record at a path
RegistryPathStatus	stat(String path) Get the status of a path
protected void	validatePath(String path) Validate a path

クラスから継承されたメソッド org.apache.hadoop.registry.client.impl.zk.CuratorService

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

クラスから継承されたメソッド org.apache.hadoop.service.CompositeService

addIfService, addService, getServices, removeService

クラスから継承されたメソッド 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

クラスから継承されたメソッド java.lang.Object

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

インタフェースから継承されたメソッド org.apache.hadoop.registry.client.api.RegistryOperations

addWriteAccessor, clearWriteAccessors

インタフェースから継承されたメソッド org.apache.hadoop.service.Service

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

コンストラクタの詳細

RegistryOperationsService

public RegistryOperationsService(String name)

RegistryOperationsService

public RegistryOperationsService()

RegistryOperationsService

public RegistryOperationsService(String name,
                                 RegistryBindingSource bindingSource)

メソッドの詳細

getClientAcls

public List<org.apache.zookeeper.data.ACL> getClientAcls()

Get the aggregate set of ACLs the client should use to create directories

戻り値:

the ACL list

validatePath

protected void validatePath(String path)
                     throws InvalidPathnameException

Validate a path

パラメータ:

path - path to validate

例外:

InvalidPathnameException - if a path is considered invalid

mknode

public boolean mknode(String path,
                      boolean createParents)
               throws IOException

インタフェースからコピーされた説明: RegistryOperations

Create a path. It is not an error if the path exists already, be it empty or not. The createParents flag also requests creating the parents. As entries in the registry can hold data while still having child entries, it is not an error if any of the parent path elements have service records.

定義:

mknode インタフェース内 RegistryOperations

パラメータ:

path - path to create

createParents - also create the parents.

戻り値:

true if the path was created, false if it existed.

例外:

org.apache.hadoop.fs.PathNotFoundException - parent path is not in the registry.

InvalidPathnameException - path name is invalid.

IOException - Any other IO Exception.

bind

public void bind(String path,
                 ServiceRecord record,
                 int flags)
          throws IOException

インタフェースからコピーされた説明: RegistryOperations

Bind a path in the registry to a service record

定義:

bind インタフェース内 RegistryOperations

パラメータ:

path - path to service record

record - service record service record to create/update

flags - bind flags

例外:

org.apache.hadoop.fs.PathNotFoundException - the parent path does not exist

FileAlreadyExistsException - path exists but create flags do not include "overwrite"

InvalidPathnameException - path name is invalid.

IOException - Any other IO Exception.

resolve

public ServiceRecord resolve(String path)
                      throws IOException

インタフェースからコピーされた説明: RegistryOperations

Resolve the record at a path

定義:

resolve インタフェース内 RegistryOperations

パラメータ:

path - path to an entry containing a ServiceRecord

戻り値:

the record

例外:

org.apache.hadoop.fs.PathNotFoundException - path is not in the registry.

NoRecordException - if there is not a service record

InvalidRecordException - if there was a service record but it could not be parsed.

IOException - Any other IO Exception

exists

public boolean exists(String path)
               throws IOException

インタフェースからコピーされた説明: RegistryOperations

Probe for a path existing. This is equivalent to RegistryOperations.stat(String) with any failure downgraded to a

定義:

exists インタフェース内 RegistryOperations

パラメータ:

path - path to query

戻り値:

true if the path was found

例外:

IOException

stat

public RegistryPathStatus stat(String path)
                        throws IOException

インタフェースからコピーされた説明: RegistryOperations

Get the status of a path

定義:

stat インタフェース内 RegistryOperations

パラメータ:

path - path to query

戻り値:

the status of the path

例外:

org.apache.hadoop.fs.PathNotFoundException - path is not in the registry.

InvalidPathnameException - the path is invalid.

IOException - Any other IO Exception

list

public List<String> list(String path)
                  throws IOException

インタフェースからコピーされた説明: RegistryOperations

List all entries under a registry path, returning the relative names of the entries.

定義:

list インタフェース内 RegistryOperations

パラメータ:

path - path to query

戻り値:

a possibly empty list of the short path names of child entries.

例外:

org.apache.hadoop.fs.PathNotFoundException

InvalidPathnameException

IOException

delete

public void delete(String path,
                   boolean recursive)
            throws IOException

インタフェースからコピーされた説明: RegistryOperations

Delete a path. If the operation returns without an error then the entry has been deleted.

定義:

delete インタフェース内 RegistryOperations

パラメータ:

path - path delete recursively

recursive - recursive flag

例外:

org.apache.hadoop.fs.PathNotFoundException - path is not in the registry.

InvalidPathnameException - the path is invalid.

org.apache.hadoop.fs.PathIsNotEmptyDirectoryException - path has child entries, but recursive is false.

IOException - Any other IO Exception