RootEndpoint (Apache Ozone S3 Gateway 2.1.0 API)

java.lang.Object

org.apache.hadoop.ozone.s3.endpoint.EndpointBase

org.apache.hadoop.ozone.s3.endpoint.RootEndpoint

All Implemented Interfaces:: org.apache.hadoop.ozone.audit.Auditor

@Path("/") public class RootEndpoint extends EndpointBase

Top level rest endpoint.

Field Summary

Fields inherited from class org.apache.hadoop.ozone.s3.endpoint.EndpointBase
AUDIT, ETAG_CUSTOM, signatureInfo
Constructor Summary

Constructors

Constructor

Description

RootEndpoint()
Method Summary

Modifier and Type

Method

Description

javax.ws.rs.core.Response

get()

Rest endpoint to list all the buckets of the current user.

void

init()

Methods inherited from class org.apache.hadoop.ozone.s3.endpoint.EndpointBase
addCustomMetadataHeaders, auditReadFailure, auditWriteFailure, buildAuditMessageForFailure, buildAuditMessageForSuccess, buildAuditMessageForSuccess, createS3Bucket, deleteS3Bucket, getAuditParameters, getBucket, getBucket, getClient, getClientProtocol, getCustomMetadataFromHeaders, getMetrics, getTaggingFromHeaders, getVolume, initialization, isAccessDenied, listS3Buckets, listS3Buckets, setClient, setRequestIdentifier, setSignatureInfo, validateAndGetTagging

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- RootEndpoint
  
  public RootEndpoint()
Method Details
- get
  
  @GET public javax.ws.rs.core.Response get() throws OS3Exception, IOException
  
  Rest endpoint to list all the buckets of the current user. See https://docs.aws.amazon.com/AmazonS3/latest/API/RESTServiceGET.html for more details.
  
  Throws:
  
  OS3Exception
  
  IOException
- init
  
  public void init()
  
  Specified by:
  
  init in class EndpointBase