com.ceph.rados

Class Rados

java.lang.Object

com.ceph.rados.RadosBase

com.ceph.rados.Rados

Direct Known Subclasses:

RadosStriper

public class Rados
extends RadosBase

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Rados.RadosCommandResult Result returned by RadosCommands

Field Summary

Fields

Modifier and Type	Field and Description
protected com.sun.jna.Pointer	clusterPtr
static int	OPERATION_BALANCE_READS
static int	OPERATION_FULL_TRY
static int	OPERATION_IGNORE_CACHE
static int	OPERATION_IGNORE_OVERLAY
static int	OPERATION_LOCALIZE_READS
static int	OPERATION_NOFLAG flags for ReadOp.operate and (maybe later) WriteOp.operate See librados operate flags for more information
static int	OPERATION_ORDER_READS_WRITES
static int	OPERATION_SKIPRWLOCKS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
String	clusterFsid() Get the cluster's fsid
RadosClusterInfo	clusterStat() Get the cluster stats
String	confGet(String option) Retrieve a RADOS configuration option's value
void	confReadFile(File file) Read a Ceph configuration file
void	confSet(String option, String value) Set a RADOS configuration option
void	connect() Connect to the Ceph cluster
Rados.RadosCommandResult	executeRadosMonCommand(String[] commands, String in) Executes commands in module: 'mon' To list commands execute "get_command_descriptions"
Rados.RadosCommandResult	executeRadosMonCommandTarget(String[] commands, String target, String in) Executes commands in module: 'mon' To list commands execute "get_command_descriptions"
Rados.RadosCommandResult	executeRadosOsdCommand(String[] commands, int osdId, String in) Executes commands in module: 'osd' To list commands execute "get_command_descriptions"
protected void	finalize() Java finalizer to make sure librados is correctly released if shutDown has not been called explicitly.
long	getInstanceId() Get the global unique ID of the current connection
static int[]	getVersion() Get the librados version
IoCTX	ioCtxCreate(String pool) Create a IoCTX
void	ioCtxDestroy(IoCTX io) Destroy a IoCTX
void	poolCreate(String name) Create a RADOS pool
void	poolCreate(String name, long auid) Create a RADOS pool and set a auid
void	poolCreate(String name, long auid, long crushrule) Create a RADOS pool and set a auid and crushrule
void	poolDelete(String name) Delete a RADOS pool
String[]	poolList() List all the RADOS pools
long	poolLookup(String name) Get the ID of a RADOS pool
String	poolReverseLookup(long id) Get the name of a RADOS pool
void	shutDown() Shuts rados down

Methods inherited from class com.ceph.rados.RadosBase

handleReturnCode, throwException

Methods inherited from class java.lang.Object

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

Field Detail

OPERATION_NOFLAG

public static final int OPERATION_NOFLAG

flags for ReadOp.operate and (maybe later) WriteOp.operate See librados operate flags for more information

See Also:

Constant Field Values

OPERATION_BALANCE_READS

public static final int OPERATION_BALANCE_READS

See Also:

Constant Field Values

OPERATION_LOCALIZE_READS

public static final int OPERATION_LOCALIZE_READS

See Also:

Constant Field Values

OPERATION_ORDER_READS_WRITES

public static final int OPERATION_ORDER_READS_WRITES

See Also:

Constant Field Values

OPERATION_IGNORE_CACHE

public static final int OPERATION_IGNORE_CACHE

See Also:

Constant Field Values

OPERATION_SKIPRWLOCKS

public static final int OPERATION_SKIPRWLOCKS

See Also:

Constant Field Values

OPERATION_IGNORE_OVERLAY

public static final int OPERATION_IGNORE_OVERLAY

See Also:

Constant Field Values

OPERATION_FULL_TRY

public static final int OPERATION_FULL_TRY

See Also:

Constant Field Values

clusterPtr

protected com.sun.jna.Pointer clusterPtr

Constructor Detail

Rados

public Rados(String id)

Construct a RADOS Object which invokes rados_create

Parameters:

id - the cephx id to authenticate with

Rados

public Rados(String clustername,
             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(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(String option,
                    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 String confGet(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 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(String name)
                throws RadosException

Create a RADOS pool

Parameters:

name - the name of the pool to be created

Throws:

RadosException

poolCreate

public void poolCreate(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(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(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 Throwable

Java finalizer to make sure librados is correctly released if shutDown has not been called explicitly.

Overrides:

finalize in class Object

Throws:

Throwable

poolList

public String[] poolList()
                  throws RadosException

List all the RADOS pools

Returns:

String[] list of pools

Throws:

RadosException

poolLookup

public long poolLookup(String name)
                throws RadosException

Get the ID of a RADOS pool

Parameters:

name - The name of the pool

Returns:

long

Throws:

RadosException

poolReverseLookup

public 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(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

shutDown

public void shutDown()

Shuts rados down

executeRadosMonCommand

public Rados.RadosCommandResult executeRadosMonCommand(String[] commands,
                                                       String in)
                                                throws RadosException

Executes commands in module: 'mon' To list commands execute "get_command_descriptions"

Parameters:

commands - Commands to execute

in - inputbuffer

Returns:

Returns a RadosCommandResult-object

Throws:

RadosException

executeRadosMonCommandTarget

public Rados.RadosCommandResult executeRadosMonCommandTarget(String[] commands,
                                                             String target,
                                                             String in)
                                                      throws RadosException

Executes commands in module: 'mon' To list commands execute "get_command_descriptions"

Parameters:

commands - Command to execute

target - Monitor target to execute commands

in - inputbuffer

Returns:

Returns a RadosCommandResult-object

Throws:

RadosException

executeRadosOsdCommand

public Rados.RadosCommandResult executeRadosOsdCommand(String[] commands,
                                                       int osdId,
                                                       String in)
                                                throws RadosException

Executes commands in module: 'osd' To list commands execute "get_command_descriptions"

Parameters:

commands - Command to execute

osdId - OSD used to process this commands

in - inputbuffer

Returns:

Returns a RadosCommandResult-object

Throws:

RadosException