-BackupHandler (Oracle - Berkeley DB Java API) -

From 780b92ada9afcf1d58085a83a0b9e6bc982203d1 Mon Sep 17 00:00:00 2001 From: Lorry Tar Creator Date: Tue, 17 Feb 2015 17:25:57 +0000 Subject: Imported from /home/lorry/working-area/delta_berkeleydb/db-6.1.23.tar.gz. --- docs/java/com/sleepycat/db/BackupHandler.html | 504 +++++++++++++------------- 1 file changed, 249 insertions(+), 255 deletions(-) (limited to 'docs/java/com/sleepycat/db/BackupHandler.html') diff --git a/docs/java/com/sleepycat/db/BackupHandler.html b/docs/java/com/sleepycat/db/BackupHandler.html index 5ef7273c..f4245ceb 100644 --- a/docs/java/com/sleepycat/db/BackupHandler.html +++ b/docs/java/com/sleepycat/db/BackupHandler.html @@ -1,283 +1,277 @@ - - - - - -BackupHandler (Oracle - Berkeley DB Java API) - - - - - - - - - - - - -

- - +//--> + + - - - - - - - - - - - - - - - - -

- - - - - - - - - - - - -

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

-

-Berkeley DB
version 5.3.21 -

- PREV CLASS - NEXT CLASS

- FRAMES - NO FRAMES - - - - -

- SUMMARY: NESTED | FIELD | CONSTR | METHOD

-DETAIL: FIELD | CONSTR | METHOD

- + + +

+

Summary:
Nested |
Field |
Constr |
Method

+

Detail:
Field |
Constr |
Method

+

+ + + - -

-

- -com.sleepycat.db -
-Interface BackupHandler

-

-

public interface BackupHandler

- - -

-An interface that can optionally be used to override the default behavior +

+

+

+

+
+
+
```
public interface BackupHandler
```
+
An interface that can optionally be used to override the default behavior performed by the -Environment.backup +Environment.backup and -Environment.backupDatabase +Environment.backupDatabase methods. Implementation of this interface is required if the Environment.backup or Environment.backupDatabase target parameter is null.
You configure the environment with this handler using the -EnvironmentConfig.setBackupHandler -method. -
- -
-
- -
- +EnvironmentConfig.setBackupHandler +method.
+

+

+

+

- - - - - - - - - - - - - - - - - - -

-Method Summary
- `int`	`close(String dbname)` - - - Called when ending a backup and closing a backup target.
- `int`	`open(String target, - String dbname)` - - - Called when a target location is opened during a backup.
- `int`	`write(long file_pos, - byte[] buf, - int off, - int len)` - - - Called when writing data during a backup.

- -

- +

Method Summary

+ + + + + + + + + + + + + + + + + + +

Methods
Modifier and Type	Method and Description
`int`	`close(java.lang.String dbname)` + Called when ending a backup and closing a backup target. +
`int`	`open(java.lang.String target, + java.lang.String dbname)` + Called when a target location is opened during a backup. +
`int`	`write(long file_pos, + byte[] buf, + int off, + int len)` + Called when writing data during a backup. +

+

+

+

+

+

- - - - - - -
-Method Detail
- -
-close
-
```
-int close(String dbname)
```
-
-
Called when ending a backup and closing a backup target. -
-
-
-
Parameters:
dbname - The name of the database that has been backed up.
-
-
-
- -
-open
-
```
-int open(String target,
-         String dbname)
```
-
-
Called when a target location is opened during a backup. This method +
- + + +
  Method Detail
  + + + +
  - +
    close
    +
    int close(java.lang.String dbname)
    +
    Called when ending a backup and closing a backup target. +
    +
    Parameters:
    dbname - The name of the database that has been backed up.
    +
  + + + +
  - +
    open
    +
    int open(java.lang.String target, + java.lang.String dbname)
    +
    Called when a target location is opened during a backup. This method should do whatever is necessary to prepare the backup destination for writing the data. -
    -
    -
    -
    Parameters:
    target - The backup's directory destination. -
    dbname - The name of the database being backed up.
    -
    -
-
- -
-write
-
```
-int write(long file_pos,
-          byte[] buf,
-          int off,
-          int len)
```
-
-
Called when writing data during a backup. -
-
-
-
Parameters:
file_pos - Identifies the position in the target file where the bytes +

+

Parameters:: target - The backup's directory destination. +; dbname - The name of the database being backed up.

+ + + + + +

+
write
+
```
int write(long file_pos,
+        byte[] buf,
+        int off,
+        int len)
```
+
Called when writing data during a backup. +
+
Parameters:
file_pos - Identifies the position in the target file where the bytes from the buffer should be written. -
buf - Identifies the buffer which contains the data to be backed up. -
off - Specifies the start of the data in the buffer. This will always be +
buf - Identifies the buffer which contains the data to be backed up. +
off - Specifies the start of the data in the buffer. This will always be zero. -
len - Identifies the number of bytes to back up from the buffer.
- - +
len - Identifies the number of bytes to back up from the buffer.
+

+ + + + +

+ -

- - - - - - - - - - - - - - - - - - -

- - - - - - - - - - - - -

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

-

-Berkeley DB
version 5.3.21 -

- PREV CLASS - NEXT CLASS

- FRAMES - NO FRAMES - - - - -

- SUMMARY: NESTED | FIELD | CONSTR | METHOD

-DETAIL: FIELD | CONSTR | METHOD

- + + +

+

Summary:
Nested |
Field |
Constr |
Method

+

Detail:
Field |
Constr |
Method

+

+ + + - -

-Copyright (c) 1996, 2012 Oracle and/or its affiliates. All rights reserved. - - +

Copyright (c) 1996, 2015 Oracle and/or its affiliates. All rights reserved.

+ + -- cgit v1.2.1