com.ceph.rbd

Class RbdImage

java.lang.Object

com.ceph.rbd.RbdImage

All Implemented Interfaces:

Closeable, AutoCloseable

public class RbdImage
extends Object
implements Closeable

Constructor Summary

Constructors

Constructor and Description
RbdImage(com.sun.jna.Pointer image, String name)

Method Summary

Modifier and Type	Method and Description
void	close()
void	flatten()
String	getName() Returns the name of the image
com.sun.jna.Pointer	getPointer() Return the pointer to the RBD image This method is used internally and by the RBD class to close a RBD image
boolean	isOldFormat() Find out if the format of the RBD image is the old format or not
List<String>	listChildren(String snapname) List children of a snapshot
int	read(long offset, byte[] buffer, int length) Read from an RBD image
void	resize(long size) Resize an RBD image
void	snapCreate(String snapName) Create a RBD snapshot
boolean	snapIsProtected(String snapName) Tells if a snapshot is protected or not
List<RbdSnapInfo>	snapList() List all snapshots
List<RbdSnapInfo>	snapList(int initialBufferSize) List all snapshots
void	snapProtect(String snapName) Protect a snapshot
void	snapRemove(String snapName) Remove a RBD snapshot
void	snapRollBack(String snapName) Rollback a RBD snapshot
void	snapUnprotect(String snapName) Unprotect a RBD snapshot
RbdImageInfo	stat() Get information about a RBD image
void	write(byte[] data) Write data to an RBD image
void	write(byte[] data, long offset) Write data to an RBD image
void	write(byte[] data, long offset, int length) Write data to an RBD image

Methods inherited from class java.lang.Object

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

Constructor Detail

RbdImage

public RbdImage(com.sun.jna.Pointer image,
                String name)

Method Detail

getName

public String getName()

Returns the name of the image

Returns:

String

getPointer

public com.sun.jna.Pointer getPointer()

Return the pointer to the RBD image This method is used internally and by the RBD class to close a RBD image

Returns:

Pointer

stat

public RbdImageInfo stat()
                  throws RbdException

Get information about a RBD image

Returns:

RbdImageInfo

Throws:

RbdException

isOldFormat

public boolean isOldFormat()
                    throws RbdException

Find out if the format of the RBD image is the old format or not

Returns:

boolean

Throws:

RbdException

snapCreate

public void snapCreate(String snapName)
                throws RbdException

Create a RBD snapshot

Parameters:

snapName - The name for the snapshot

Throws:

RbdException

snapRemove

public void snapRemove(String snapName)
                throws RbdException

Remove a RBD snapshot

Parameters:

snapName - The name of the snapshot

Throws:

RbdException

snapRollBack

public void snapRollBack(String snapName)
                  throws RbdException

Rollback a RBD snapshot

Parameters:

snapName - The name of the snapshot

Throws:

RbdException

snapProtect

public void snapProtect(String snapName)
                 throws RbdException

Protect a snapshot

Parameters:

snapName - The name of the snapshot

Throws:

RbdException

snapUnprotect

public void snapUnprotect(String snapName)
                   throws RbdException

Unprotect a RBD snapshot

Parameters:

snapName - The name of the snapshot

Throws:

RbdException

snapIsProtected

public boolean snapIsProtected(String snapName)
                        throws RbdException

Tells if a snapshot is protected or not

Parameters:

snapName - The name of the snapshot

Returns:

boolean

Throws:

RbdException

snapList

public List<RbdSnapInfo> snapList()
                           throws RbdException

List all snapshots

Returns:

List

Throws:

RbdException

snapList

public List<RbdSnapInfo> snapList(int initialBufferSize)
                           throws RbdException

List all snapshots

Parameters:

initialBufferSize - Initial size of the byte buffer holding snapshot names

Returns:

List

Throws:

RbdException

write

public void write(byte[] data,
                  long offset,
                  int length)
           throws RbdException

Write data to an RBD image

Parameters:

data - The to be written data

offset - Where to start writing

length - The number of bytes to write

Throws:

RbdException

write

public void write(byte[] data,
                  long offset)
           throws RbdException

Write data to an RBD image

Parameters:

data - The to be written data

offset - Where to start writing

Throws:

RbdException

write

public void write(byte[] data)
           throws RbdException

Write data to an RBD image

Parameters:

data - The to be written data

Throws:

RbdException

read

public int read(long offset,
                byte[] buffer,
                int length)

Read from an RBD image

Parameters:

offset - Where to start reading

buffer - The buffer to store the result

length - The amount of bytes to read

Returns:

int The amount of bytes read

resize

public void resize(long size)
            throws RbdException

Resize an RBD image

Parameters:

size - The new size for the RBD image

Throws:

RbdException

flatten

public void flatten()
             throws RbdException

Throws:

RbdException

listChildren

public List<String> listChildren(String snapname)
                          throws RbdException

List children of a snapshot

Parameters:

snapname - Name of the snapshot on RBD image

Returns:

List of children with each element in the list in pool/image format

Throws:

RbdException

close

public void close()
           throws RbdException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

RbdException