Documentation ¶
Index ¶
- Constants
- func GetObjectAttributes(ctx context.Context, pool *pool.Pool, attrs []*models.Attribute, ...) ([]object.Attribute, error)
- func IsObjectToken(token *models.Bearer) (bool, error)
- type API
- func (a *API) Balance(params operations.GetBalanceParams) middleware.Responder
- func (a *API) Configure(api *operations.FrostfsRestGwAPI) http.Handler
- func (a *API) DeleteContainer(params operations.DeleteContainerParams, principal *models.Principal) middleware.Responder
- func (a *API) DeleteObject(params operations.DeleteObjectParams, principal *models.Principal) middleware.Responder
- func (a *API) FormBinaryBearer(params operations.FormBinaryBearerParams, principal *models.Principal) middleware.Responder
- func (a *API) GetContainer(params operations.GetContainerParams) middleware.Responder
- func (a *API) GetContainerEACL(params operations.GetContainerEACLParams) middleware.Responder
- func (a *API) GetObjectInfo(params operations.GetObjectInfoParams, principal *models.Principal) middleware.Responder
- func (a *API) ListContainer(params operations.ListContainersParams) middleware.Responder
- func (a *API) OptionsAuth(operations.OptionsAuthParams) middleware.Responder
- func (a *API) OptionsAuthBearer(operations.OptionsAuthBearerParams) middleware.Responder
- func (a *API) OptionsContainersEACL(operations.OptionsContainersEACLParams) middleware.Responder
- func (a *API) OptionsContainersGetDelete(operations.OptionsContainersGetDeleteParams) middleware.Responder
- func (a *API) OptionsContainersPutList(operations.OptionsContainersPutListParams) middleware.Responder
- func (a *API) OptionsObjectSearch(operations.OptionsObjectsSearchParams) middleware.Responder
- func (a *API) OptionsObjectsGetDelete(operations.OptionsObjectsGetDeleteParams) middleware.Responder
- func (a *API) OptionsObjectsPut(operations.OptionsObjectsPutParams) middleware.Responder
- func (a *API) PostAuth(params operations.AuthParams) middleware.Responder
- func (a *API) PutContainerEACL(params operations.PutContainerEACLParams, principal *models.Principal) middleware.Responder
- func (a *API) PutContainers(params operations.PutContainerParams, principal *models.Principal) middleware.Responder
- func (a *API) PutObjects(params operations.PutObjectParams, principal *models.Principal) middleware.Responder
- func (a API) RunServices()
- func (a *API) SearchObjects(params operations.SearchObjectsParams, principal *models.Principal) middleware.Responder
- func (a API) StartCallback()
- type BearerToken
- type ContextKey
- type PrmAPI
- type PrmAttributes
- type SessionToken
Constants ¶
const ( SystemAttributePrefix = "__SYSTEM__" ExpirationDurationAttr = SystemAttributePrefix + "EXPIRATION_DURATION" ExpirationTimestampAttr = SystemAttributePrefix + "EXPIRATION_TIMESTAMP" ExpirationRFC3339Attr = SystemAttributePrefix + "EXPIRATION_RFC3339" )
Variables ¶
This section is empty.
Functions ¶
Types ¶
type API ¶
type API struct {
// contains filtered or unexported fields
}
API is a REST v1 request handler.
func (*API) Balance ¶
func (a *API) Balance(params operations.GetBalanceParams) middleware.Responder
Balance handler that get balance from FrostFS.
func (*API) Configure ¶
func (a *API) Configure(api *operations.FrostfsRestGwAPI) http.Handler
func (*API) DeleteContainer ¶
func (a *API) DeleteContainer(params operations.DeleteContainerParams, principal *models.Principal) middleware.Responder
DeleteContainer handler that returns container info.
func (*API) DeleteObject ¶
func (a *API) DeleteObject(params operations.DeleteObjectParams, principal *models.Principal) middleware.Responder
DeleteObject handler that removes object from FrostFS.
func (*API) FormBinaryBearer ¶
func (a *API) FormBinaryBearer(params operations.FormBinaryBearerParams, principal *models.Principal) middleware.Responder
FormBinaryBearer handler that forms binary bearer token using headers with body and signature.
func (*API) GetContainer ¶
func (a *API) GetContainer(params operations.GetContainerParams) middleware.Responder
GetContainer handler that returns container info.
func (*API) GetContainerEACL ¶
func (a *API) GetContainerEACL(params operations.GetContainerEACLParams) middleware.Responder
GetContainerEACL handler that returns container eacl.
func (*API) GetObjectInfo ¶
func (a *API) GetObjectInfo(params operations.GetObjectInfoParams, principal *models.Principal) middleware.Responder
GetObjectInfo handler that get object info.
func (*API) ListContainer ¶
func (a *API) ListContainer(params operations.ListContainersParams) middleware.Responder
ListContainer handler that returns containers.
func (*API) OptionsAuth ¶
func (a *API) OptionsAuth(operations.OptionsAuthParams) middleware.Responder
func (*API) OptionsAuthBearer ¶
func (a *API) OptionsAuthBearer(operations.OptionsAuthBearerParams) middleware.Responder
func (*API) OptionsContainersEACL ¶
func (a *API) OptionsContainersEACL(operations.OptionsContainersEACLParams) middleware.Responder
func (*API) OptionsContainersGetDelete ¶
func (a *API) OptionsContainersGetDelete(operations.OptionsContainersGetDeleteParams) middleware.Responder
func (*API) OptionsContainersPutList ¶
func (a *API) OptionsContainersPutList(operations.OptionsContainersPutListParams) middleware.Responder
func (*API) OptionsObjectSearch ¶
func (a *API) OptionsObjectSearch(operations.OptionsObjectsSearchParams) middleware.Responder
func (*API) OptionsObjectsGetDelete ¶
func (a *API) OptionsObjectsGetDelete(operations.OptionsObjectsGetDeleteParams) middleware.Responder
func (*API) OptionsObjectsPut ¶
func (a *API) OptionsObjectsPut(operations.OptionsObjectsPutParams) middleware.Responder
func (*API) PostAuth ¶
func (a *API) PostAuth(params operations.AuthParams) middleware.Responder
PostAuth handler that forms bearer token to sign.
func (*API) PutContainerEACL ¶
func (a *API) PutContainerEACL(params operations.PutContainerEACLParams, principal *models.Principal) middleware.Responder
PutContainerEACL handler that update container eacl.
func (*API) PutContainers ¶
func (a *API) PutContainers(params operations.PutContainerParams, principal *models.Principal) middleware.Responder
PutContainers handler that creates container in FrostFS.
func (*API) PutObjects ¶
func (a *API) PutObjects(params operations.PutObjectParams, principal *models.Principal) middleware.Responder
PutObjects handler that uploads object to FrostFS.
func (API) RunServices ¶
func (a API) RunServices()
func (*API) SearchObjects ¶
func (a *API) SearchObjects(params operations.SearchObjectsParams, principal *models.Principal) middleware.Responder
SearchObjects handler that removes object from FrostFS.
func (API) StartCallback ¶
func (a API) StartCallback()
type BearerToken ¶
type ContextKey ¶
type ContextKey string
ContextKey is used for context.Context value. The value requires a key that is not primitive type.
const ( // BearerPrefix is the prefix for authorization token. BearerPrefix = "Bearer " // ContextKeyRequestID is the ContextKey for RequestID. ContextKeyRequestID ContextKey = "requestID" )
type PrmAPI ¶
type PrmAPI struct { Logger *zap.Logger Pool *pool.Pool Key *keys.PrivateKey DefaultTimestamp bool GateMetric *metrics.GateMetrics PrometheusService *metrics.Service PprofService *metrics.Service ServiceShutdownTimeout time.Duration }
PrmAPI groups parameters to init rest API.
type PrmAttributes ¶
PrmAttributes groups parameters to form attributes from request headers.
type SessionToken ¶
type SessionToken struct { BearerToken Verb sessionv2.ContainerSessionVerb }