Commit 087825ed authored by chiaming2000's avatar chiaming2000
Browse files

Update admin API JavaDoc.

parent 0bdd49a0

kinetic-client/src/main/java/kinetic/admin/KineticAdminClient.java

+18 −19
Original line number Diff line number Diff line
@@ -19,14 +19,14 @@ package kinetic.admin; 


import java.util.List;



import com.seagate.kinetic.common.lib.KineticMessage;

import kinetic.client.EntryNotFoundException;

import kinetic.client.KineticException;

import kinetic.client.p2p.KineticP2pClient;



import com.seagate.kinetic.common.lib.KineticMessage;

import com.seagate.kinetic.proto.Kinetic.Command.Priority;

import com.seagate.kinetic.proto.Kinetic.Command.Range;



import kinetic.client.KineticException;

import kinetic.client.p2p.KineticP2pClient;



/**

 * 

 * Kinetic administrative client interface.
@@ -160,20 +160,19 @@ public interface KineticAdminClient extends KineticP2pClient { 
    public void setErasePin (byte[] oldErasePin, byte[] newErasePin) throws KineticException;

    

    /**

     * Erase all data in database for the drive.

     * <p>

     * Erase data in database with Db API.

     * Erase all data in database for the drive. This maybe secure or not. This

     * operation implies that it maybe faster than the secured erase

     * alternative.

     * <p>

     * Please use {@link #secureErase(byte[])} if secured erase is desirable.

     * 

     * @param pin

     *            Compare the pin with drive's pin. If equal, can download

     *            firmware the information for the drive, if not, drive will

     *            reject the firmwareDownload request.

     *            the pin used to authenticate for this operation.

     * 

     * @throws KineticException

     *             if unable to load firmware bytes to the drive.

     * 

     * 

     * @see #secureErase(byte[])

     */

    public void instantErase(byte[] pin) throws KineticException;