com.ceph.rados

Class Rados

java.lang.Object

com.ceph.rados.Rados

public class Rados
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected com.sun.jna.Pointer	clusterPtr

Constructor Summary

Constructors

Constructor and Description
Rados() Construct a RADOS Object which invokes rados_create
Rados(java.lang.String id) Construct a RADOS Object which invokes rados_create
Rados(java.lang.String clustername, java.lang.String name, long flags) Construct a RADOS Object which invokes rados_create2

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	clusterFsid() Get the cluster's fsid
RadosClusterInfo	clusterStat() Get the cluster stats
java.lang.String	confGet(java.lang.String option) Retrieve a RADOS configuration option's value
void	confReadFile(java.io.File file) Read a Ceph configuration file
void	confSet(java.lang.String option, java.lang.String value) Set a RADOS configuration option
void	connect() Connect to the Ceph cluster
protected void	finalize()
long	getInstanceId() Get the global unique ID of the current connection
static int[]	getVersion() Get the librados version
IoCTX	ioCtxCreate(java.lang.String pool) Create a IoCTX
void	ioCtxDestroy(IoCTX io) Destroy a IoCTX
void	poolCreate(java.lang.String name) Create a RADOS pool
void	poolCreate(java.lang.String name, long auid) Create a RADOS pool and set a auid
void	poolCreate(java.lang.String name, long auid, long crushrule) Create a RADOS pool and set a auid and crushrule
void	poolDelete(java.lang.String name) Delete a RADOS pool
java.lang.String[]	poolList() List all the RADOS pools
long	poolLookup(java.lang.String name) Get the ID of a RADOS pool
java.lang.String	poolReverseLookup(long id) Get the name of a RADOS pool

Methods inherited from class java.lang.Object

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

Field Detail

clusterPtr

protected com.sun.jna.Pointer clusterPtr

Constructor Detail

Rados

public Rados(java.lang.String id)

Construct a RADOS Object which invokes rados_create

Parameters:

id - the cephx id to authenticate with

Rados

public Rados(java.lang.String clustername,
     java.lang.String name,
     long flags)

Construct a RADOS Object which invokes rados_create2

Parameters:

clustername - The name of the cluster (usually "ceph").

name - The name of the user (e.g., client.admin, client.user)

flags - Flag options (future use).

Rados

public Rados()

Construct a RADOS Object which invokes rados_create

Method Detail

confReadFile

public void confReadFile(java.io.File file)
                  throws RadosException

Read a Ceph configuration file

Parameters:

file - A file object with the path to a ceph.conf

Throws:

RadosException

confSet

public void confSet(java.lang.String option,
           java.lang.String value)
             throws RadosException

Set a RADOS configuration option

Parameters:

option - the name of the option

value - the value configuration value

Throws:

RadosException

confGet

public java.lang.String confGet(java.lang.String option)
                         throws RadosException

Retrieve a RADOS configuration option's value

Parameters:

option - the name of the option

Returns:

the value of the option

Throws:

RadosException

connect

public void connect()
             throws RadosException

Connect to the Ceph cluster

Throws:

RadosException

clusterFsid

public java.lang.String clusterFsid()
                             throws RadosException

Get the cluster's fsid

Returns:

A string containing the cluster's fsid

Throws:

RadosException

clusterStat

public RadosClusterInfo clusterStat()
                             throws RadosException

Get the cluster stats

Returns:

RadosClusterInfo

Throws:

RadosException

poolCreate

public void poolCreate(java.lang.String name)
                throws RadosException

Create a RADOS pool

Parameters:

name - the name of the pool to be created

Throws:

RadosException

poolCreate

public void poolCreate(java.lang.String name,
              long auid)
                throws RadosException

Create a RADOS pool and set a auid

Parameters:

name - the name of the pool to be created

auid - the owner ID for the new pool

Throws:

RadosException

poolCreate

public void poolCreate(java.lang.String name,
              long auid,
              long crushrule)
                throws RadosException

Create a RADOS pool and set a auid and crushrule

Parameters:

name - the name of the pool to be created

auid - the owner ID for the new pool

crushrule - the crushrule for this pool

Throws:

RadosException

poolDelete

public void poolDelete(java.lang.String name)
                throws RadosException

Delete a RADOS pool

Parameters:

name - the name of the pool to be deleted

Throws:

RadosException

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

poolList

public java.lang.String[] poolList()
                            throws RadosException

List all the RADOS pools

Returns:

String[]

Throws:

RadosException

poolLookup

public long poolLookup(java.lang.String name)
                throws RadosException

Get the ID of a RADOS pool

Parameters:

name - The name of the pool

Returns:

long

Throws:

RadosException

poolReverseLookup

public java.lang.String poolReverseLookup(long id)
                                   throws RadosException

Get the name of a RADOS pool

Parameters:

id - The id of the pool

Returns:

String

Throws:

RadosException

ioCtxCreate

public IoCTX ioCtxCreate(java.lang.String pool)
                  throws RadosException

Create a IoCTX

Parameters:

pool - The name of the RADOS pool

Returns:

IoCTX

Throws:

RadosException

ioCtxDestroy

public void ioCtxDestroy(IoCTX io)

Destroy a IoCTX

Parameters:

io - A IoCTX object

getInstanceId

public long getInstanceId()
                   throws RadosException

Get the global unique ID of the current connection

Returns:

long

Throws:

RadosException

getVersion

public static int[] getVersion()

Get the librados version

Returns:

a int array with the minor, major and extra version