Package org.apache.hadoop.ozone.om.response

Class OMClientResponse

java.lang.Object
org.apache.hadoop.ozone.om.response.OMClientResponse
Direct Known Subclasses:
DummyOMClientResponse, OMBucketAclResponse, OMBucketCreateResponse, OMBucketDeleteResponse, OMBucketSetOwnerResponse, OMBucketSetPropertyResponse, OMCancelDelegationTokenResponse, OMCancelPrepareResponse, OMEchoRPCWriteResponse, OMFinalizeUpgradeResponse, OMGetDelegationTokenResponse, OmKeyResponse, OMKeysRenameResponse, OMPrefixAclResponse, OMPrepareResponse, OMQuotaRepairResponse, OMRenewDelegationTokenResponse, OMSetRangerServiceVersionResponse, OMSetSecretResponse, OMSnapshotCreateResponse, OMSnapshotDeleteResponse, OMSnapshotMoveDeletedKeysResponse, OMSnapshotMoveTableKeysResponse, OMSnapshotPurgeResponse, OMSnapshotRenameResponse, OMSnapshotSetPropertyResponse, OMTenantAssignAdminResponse, OMTenantAssignUserAccessIdResponse, OMTenantCreateResponse, OMTenantDeleteResponse, OMTenantRevokeAdminResponse, OMTenantRevokeUserAccessIdResponse, OMVolumeAclOpResponse, OMVolumeCreateResponse, OMVolumeDeleteResponse, OMVolumeSetOwnerResponse, OMVolumeSetQuotaResponse, S3GetSecretResponse, S3RevokeSecretResponse
public abstract class OMClientResponse extends Object
Interface for OM Responses, each OM response should implement this interface.

  • Constructor Summary

    Constructors
    Constructor
    Description
    OMClientResponse(org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.OMResponse omResponse)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected abstract void
    addToDBBatch(org.apache.hadoop.ozone.om.OMMetadataManager omMetadataManager, org.apache.hadoop.hdds.utils.db.BatchOperation batchOperation)
    Implement logic to add the response to batch.
    void
    checkAndUpdateDB(org.apache.hadoop.ozone.om.OMMetadataManager omMetadataManager, org.apache.hadoop.hdds.utils.db.BatchOperation batchOperation)
    Check if omResponse status is OK.
    void
    checkStatusNotOK()
    For error case, check that the status of omResponse is not OK.
    org.apache.hadoop.ozone.om.helpers.BucketLayout
    getBucketLayout()
     
    org.apache.hadoop.ozone.om.lock.OMLockDetails
    getOmLockDetails()
     
    org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.OMResponse
    getOMResponse()
    Return OMResponse.
    void
    setOmLockDetails(org.apache.hadoop.ozone.om.lock.OMLockDetails omLockDetails)
     

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • OMClientResponse

      public OMClientResponse(org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.OMResponse omResponse)

  • Method Details

    • getBucketLayout

      public org.apache.hadoop.ozone.om.helpers.BucketLayout getBucketLayout()

    • checkStatusNotOK

      public void checkStatusNotOK()
      For error case, check that the status of omResponse is not OK.

    • checkAndUpdateDB

      public void checkAndUpdateDB(org.apache.hadoop.ozone.om.OMMetadataManager omMetadataManager, org.apache.hadoop.hdds.utils.db.BatchOperation batchOperation) throws IOException
      Check if omResponse status is OK. If yes, add to DB. For OmResponse with failure, this should do nothing. This method is not called in failure scenario in OM code.
      Throws:
      IOException

    • addToDBBatch

      protected abstract void addToDBBatch(org.apache.hadoop.ozone.om.OMMetadataManager omMetadataManager, org.apache.hadoop.hdds.utils.db.BatchOperation batchOperation) throws IOException
      Implement logic to add the response to batch. This function should be called from checkAndUpdateDB only.
      Throws:
      IOException

    • getOMResponse

      public org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.OMResponse getOMResponse()
      Return OMResponse.
      Returns:
      OMResponse

    • getOmLockDetails

      public org.apache.hadoop.ozone.om.lock.OMLockDetails getOmLockDetails()

    • setOmLockDetails

      public void setOmLockDetails(org.apache.hadoop.ozone.om.lock.OMLockDetails omLockDetails)