com.ceph.rbd

Class RbdImage

java.lang.Object

com.ceph.rbd.RbdImage

public class RbdImage
extends java.lang.Object

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.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
long	read(long offset, byte[] buffer, long length) Read from an RBD image
void	snapCreate(java.lang.String snapName) Create a RBD snapshot
boolean	snapIsProtected(java.lang.String snapName) Tells if a snapshot is protected or not
java.util.List<RbdSnapInfo>	snapList() List all snapshots
void	snapProtect(java.lang.String snapName) Protect a snapshot
void	snapRemove(java.lang.String snapName) Remove a RBD snapshot
void	snapUnprotect(java.lang.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,
        java.lang.String name)

Method Detail

getName

public java.lang.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(java.lang.String snapName)
                throws RbdException

Create a RBD snapshot

Parameters:

snapName - The name for the snapshot

Throws:

RbdException

snapRemove

public void snapRemove(java.lang.String snapName)
                throws RbdException

Remove a RBD snapshot

Parameters:

snapName - The name of the snapshot

Throws:

RbdException

snapProtect

public void snapProtect(java.lang.String snapName)
                 throws RbdException

Protect a snapshot

Parameters:

snapName - The name of the snapshot

Throws:

RbdException

snapUnprotect

public void snapUnprotect(java.lang.String snapName)
                   throws RbdException

Unprotect a RBD snapshot

Parameters:

snapName - The name of the snapshot

Throws:

RbdException

snapIsProtected

public boolean snapIsProtected(java.lang.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 java.util.List<RbdSnapInfo> snapList()
                                     throws RbdException

List all snapshots

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 long read(long offset,
        byte[] buffer,
        long 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:

long The amount of bytes read