com.ceph.rados

Class IoCTX

java.lang.Object

com.ceph.rados.RadosBase

com.ceph.rados.IoCTX

All Implemented Interfaces:

Closeable, AutoCloseable

public class IoCTX
extends RadosBase
implements Closeable

Constructor Summary

Constructors

Constructor and Description
IoCTX(com.sun.jna.Pointer p) Create a new IO Context object This constructor should never be called, IO Context objects are created by the RADOS class and returned when creating a IO Context there

Method Summary

Modifier and Type	Method and Description
void	aioFlush() Block until all pending writes in an io context are safe.
void	aioWrite(String oid, Completion completion, byte[] buf) Asynchronously write to an object without an offset
void	aioWrite(String oid, Completion completion, byte[] buf, long offset) Asynchronously write to an object
void	aioWrite(String oid, Completion completion, String buf) Asynchronously write to an object without an offset
void	aioWrite(String oid, Completion completion, String buf, long offset) Asynchronously write to an object without an offset
void	aioWriteFull(String oid, Completion completion, byte[] buf, int len) Asynchronously write an entire object The object is filled with the provided data.
void	append(String oid, byte[] buf) Append data to an object
void	append(String oid, byte[] buf, int len)
void	append(String oid, String buf) Append data to an object
void	clone(String dst, long dst_off, String src, long src_off, long len) Efficiently copy a portion of one object to another If the underlying filesystem on the OSD supports it, this will be a copy-on-write clone.
void	close()
long	getAuid() Get the associated auid owner of the current pool
String	getExtendedAttribute(String oid, String xattrName) Get the value of an extended attribute on an object.
Map<String,String>	getExtendedAttributes(String oid) Get all extended attributes on an object.
long	getId() Get the pool ID of this context
com.sun.jna.Pointer	getPointer() Return the pointer to the IO Context This method is used internally and by the RADOS class to destroy a IO Context
String	getPoolName() Get the pool name of the context
String[]	listObjects() List all objects in a pool
ListCtx	listObjectsPartial(int limit) List all objects in a pool by piece.
void	locatorSetKey(String key) Set the locator key
RadosPoolInfo	poolStat() Stat the currently open pool
int	read(String oid, int length, long offset, byte[] buf) Read data from an object
ReadOp	readOpCreate()
void	readOpRelease(ReadOp read_op) Deprecated.
void	remove(String oid) Remove an object
void	removeExtendedAttribute(String oid, String xattrName) Delete an extended attribute from an object.
void	setAuid(long auid) Set the associated auid owner of the current pool
void	setExtendedAttribute(String oid, String xattrName, String val) Set an extended attribute on an object.
void	setNamespace(String namespace) Set the namespace for objects within an IO context.
void	snapCreate(String snapname) Create a snapshot
String	snapGetName(long id) Get the name of a snapshot by it's ID
long	snapGetStamp(long id) Get the timestamp of a snapshot
Long[]	snapList() List all snapshots
long	snapLookup(String snapname) Get the ID of a snapshot
void	snapRemove(String snapname) Remove a snapshot
RadosObjectInfo	stat(String oid) Stat an object
void	truncate(String oid, long size) Resize an object
void	write(String oid, byte[] buf) Write to an object without an offset
void	write(String oid, byte[] buf, long offset) Write to an object
void	write(String oid, String buf) Write to an object without an offset
void	write(String oid, String buf, long offset) Write to an object without an offset
void	writeFull(String oid, byte[] buf, int len) Write an entire object The object is filled with the provided data.

Methods inherited from class com.ceph.rados.RadosBase

handleReturnCode, throwException

Methods inherited from class java.lang.Object

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

Constructor Detail

IoCTX

public IoCTX(com.sun.jna.Pointer p)

Create a new IO Context object This constructor should never be called, IO Context objects are created by the RADOS class and returned when creating a IO Context there

Method Detail

getPointer

public com.sun.jna.Pointer getPointer()

Return the pointer to the IO Context This method is used internally and by the RADOS class to destroy a IO Context

Returns:

Pointer

setNamespace

public void setNamespace(String namespace)

Set the namespace for objects within an IO context. The namespace specification further refines a pool into different domains. The mapping of objects to PGs is also based on this value.

Parameters:

namespace - The name to use as the namespace, or NULL use the default namespace.

getId

public long getId()

Get the pool ID of this context

Returns:

long

setAuid

public void setAuid(long auid)
             throws RadosException

Set the associated auid owner of the current pool

Parameters:

auid - The new auid

Throws:

RadosException

getAuid

public long getAuid()
             throws RadosException

Get the associated auid owner of the current pool

Returns:

long

Throws:

RadosException

getPoolName

public String getPoolName()
                   throws RadosException

Get the pool name of the context

Returns:

String

Throws:

RadosException

locatorSetKey

public void locatorSetKey(String key)

Set the locator key

Parameters:

key - The new locator key or NULL to remove a previous one

listObjects

public String[] listObjects()
                     throws RadosException

List all objects in a pool

Returns:

String[]

Throws:

RadosException

listObjectsPartial

public ListCtx listObjectsPartial(int limit)
                           throws RadosException

List all objects in a pool by piece. Useful if a lot of objects are in the pool and do not fit in memory through listObjects() method

Parameters:

limit -

Returns:

a ListCtx from which nextObjects()/nextObjects(skip) and getObjects() could be called

Throws:

RadosException

write

public void write(String oid,
                  byte[] buf,
                  long offset)
           throws RadosException,
                  IllegalArgumentException

Write to an object

Parameters:

oid - The object to write to

buf - The content to write

offset - The offset when writing

Throws:

RadosException

IllegalArgumentException

write

public void write(String oid,
                  byte[] buf)
           throws RadosException

Write to an object without an offset

Parameters:

oid - The object to write to

buf - The content to write

Throws:

RadosException

writeFull

public void writeFull(String oid,
                      byte[] buf,
                      int len)
               throws RadosException

Write an entire object The object is filled with the provided data. If the object exists, it is atomically truncated and then written.

Parameters:

oid - The object to write to

buf - The content to write

len - The length of the data to write

Throws:

RadosException

write

public void write(String oid,
                  String buf,
                  long offset)
           throws RadosException

Write to an object without an offset

Parameters:

oid - The object to write to

buf - The content to write

offset - The offset when writing

Throws:

RadosException

write

public void write(String oid,
                  String buf)
           throws RadosException

Write to an object without an offset

Parameters:

oid - The object to write to

buf - The content to write

Throws:

RadosException

aioWrite

public void aioWrite(String oid,
                     Completion completion,
                     byte[] buf,
                     long offset)
              throws RadosException,
                     IllegalArgumentException

Asynchronously write to an object

Parameters:

oid - The object to write to

completion - The completion instructions

buf - The content to write

offset - The offset when writing

Throws:

RadosException

IllegalArgumentException

aioWrite

public void aioWrite(String oid,
                     Completion completion,
                     byte[] buf)
              throws RadosException

Asynchronously write to an object without an offset

Parameters:

oid - The object to write to

completion - The completion instructions

buf - The content to write

Throws:

RadosException

aioWriteFull

public void aioWriteFull(String oid,
                         Completion completion,
                         byte[] buf,
                         int len)
                  throws RadosException

Asynchronously write an entire object The object is filled with the provided data. If the object exists, it is atomically truncated and then written.

Parameters:

oid - The object to write to

completion - The completion instructions

buf - The content to write

len - The length of the data to write

Throws:

RadosException

aioWrite

public void aioWrite(String oid,
                     Completion completion,
                     String buf,
                     long offset)
              throws RadosException

Asynchronously write to an object without an offset

Parameters:

oid - The object to write to

completion - The completion instructions

buf - The content to write

offset - The offset when writing

Throws:

RadosException

aioWrite

public void aioWrite(String oid,
                     Completion completion,
                     String buf)
              throws RadosException

Asynchronously write to an object without an offset

Parameters:

oid - The object to write to

completion - The completion instructions

buf - The content to write

Throws:

RadosException

aioFlush

public void aioFlush()
              throws RadosException

Block until all pending writes in an io context are safe. This is not equivalent to calling rados_aio_wait_for_safe() on all write completions, since this waits for the associated callbacks to complete as well.

Throws:

RadosException

remove

public void remove(String oid)
            throws RadosException

Remove an object

Parameters:

oid - The object to remove

Throws:

RadosException

read

public int read(String oid,
                int length,
                long offset,
                byte[] buf)
         throws RadosException

Read data from an object

Parameters:

oid - The object's name

length - Amount of bytes to read

offset - The offset where to start reading

buf - The buffer to store the result

Returns:

Number of bytes read or negative on error

Throws:

RadosException

truncate

public void truncate(String oid,
                     long size)
              throws RadosException

Resize an object

Parameters:

oid - The object to resize

size - The new length of the object. If this enlarges the object, the new area is logically filled with zeroes. If this shrinks the object, the excess data is removed.

Throws:

RadosException

append

public void append(String oid,
                   byte[] buf)
            throws RadosException

Append data to an object

Parameters:

oid - The name to append to

buf - The data to append

Throws:

RadosException

append

public void append(String oid,
                   byte[] buf,
                   int len)
            throws RadosException

Parameters:

oid - The name to append to

buf - The data to append

len - The number of bytes to write from buf

Throws:

RadosException

append

public void append(String oid,
                   String buf)
            throws RadosException

Append data to an object

Parameters:

oid - The name to append to

buf - The data to append

Throws:

RadosException

clone

public void clone(String dst,
                  long dst_off,
                  String src,
                  long src_off,
                  long len)
           throws RadosException

Efficiently copy a portion of one object to another If the underlying filesystem on the OSD supports it, this will be a copy-on-write clone. The src and dest objects must be in the same pg. To ensure this, the io context should have a locator key set (see IoCTX.locatorSetKey()).

Parameters:

dst - The destination object

dst_off - The offset at the destination object

src - The source object

src_off - The offset at the source object

len - The amount of bytes to copy

Throws:

RadosException

stat

public RadosObjectInfo stat(String oid)
                     throws RadosException

Stat an object

Parameters:

oid - The name of the object

Returns:

RadosObjectInfo The size and mtime of the object

Throws:

RadosException

poolStat

public RadosPoolInfo poolStat()
                       throws RadosException

Stat the currently open pool

Returns:

RadosPoolInfo

Throws:

RadosException

snapCreate

public void snapCreate(String snapname)
                throws RadosException

Create a snapshot

Parameters:

snapname - The name of the snapshot

Throws:

RadosException

snapRemove

public void snapRemove(String snapname)
                throws RadosException

Remove a snapshot

Parameters:

snapname - The name of the snapshot

Throws:

RadosException

snapLookup

public long snapLookup(String snapname)
                throws RadosException

Get the ID of a snapshot

Parameters:

snapname - The name of the snapshot

Returns:

long

Throws:

RadosException

snapGetName

public String snapGetName(long id)
                   throws RadosException

Get the name of a snapshot by it's ID

Parameters:

id - The ID of the snapshot

Returns:

String

Throws:

RadosException

snapGetStamp

public long snapGetStamp(long id)
                  throws RadosException

Get the timestamp of a snapshot

Parameters:

id - The ID of the snapshot

Returns:

long

Throws:

RadosException

snapList

public Long[] snapList()
                throws RadosException

List all snapshots

Returns:

Long[]

Throws:

RadosException

readOpCreate

public ReadOp readOpCreate()

readOpRelease

@Deprecated
public void readOpRelease(ReadOp read_op)

Deprecated.

Instead of releasing the read operation directly, better use ReadOp.close

getExtendedAttribute

public String getExtendedAttribute(String oid,
                                   String xattrName)
                            throws RadosException

Get the value of an extended attribute on an object.

Parameters:

oid - The name of the object

xattrName - The name of the extended attribute

Returns:

The value of the extended attribute

Throws:

RadosException - on failure -- common error codes: -34 (ERANGE) : value exceeds buffer -61 (ENODATA) : no such attribute

setExtendedAttribute

public void setExtendedAttribute(String oid,
                                 String xattrName,
                                 String val)
                          throws IllegalArgumentException,
                                 RadosException

Set an extended attribute on an object.

Parameters:

oid - The name of the object

xattrName - The name of the extended attribute

val - The value of the extended attribute

Throws:

IllegalArgumentException - attribute value is too long

RadosException - on failure

removeExtendedAttribute

public void removeExtendedAttribute(String oid,
                                    String xattrName)
                             throws RadosException

Delete an extended attribute from an object.

Parameters:

oid - The name of the object

xattrName - The name of the extended attribute

Throws:

RadosException - on failure

getExtendedAttributes

public Map<String,String> getExtendedAttributes(String oid)
                                         throws RadosException

Get all extended attributes on an object.

Parameters:

oid - The name of the object

Returns:

The map of the extended attributes

Throws:

RadosException - on failure

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException