com.volcengine.service.imagex.impl

Class ImageXServiceImpl

java.lang.Object

com.volcengine.service.BaseServiceImpl

com.volcengine.service.imagex.impl.ImageXServiceImpl

All Implemented Interfaces:

IBaseService, IImageXService

public class ImageXServiceImpl
extends BaseServiceImpl
implements IImageXService

Field Summary

Fields inherited from class com.volcengine.service.BaseServiceImpl

apiInfoList, serviceInfo

Method Summary

Modifier and Type	Method and Description
ApplyImageUploadResponse	applyImageUpload(ApplyImageUploadRequest req) Apply upload image.
CommitImageUploadResponse	commitImageUpload(CommitImageUploadRequest req) Commit upload image.
DeleteImageResp	deleteImages(DeleteImageReq req) Delete images.
EmbedImageHmResponse	embedImageHm(EmbedImageHmRequest req) Request ImageX api with method POST.
ExtractImageHmResponse	extractImageHm(ExtractImageHmRequest req) Request ImageX api with method POST.
GetImageOCRResponse	getImageOCR(Map<String,String> param) Request ImageX api with method POST.
GetImageSegmentResponse	getImageSegment(GetImageSegmentRequest req) Request ImageX api with method POST.
CommonResponse	getImageX(String action, Map<String,String> param) Request ImageX api with method GET.
static IImageXService	getInstance()
static IImageXService	getInstance(String region)
SecurityToken2	getUploadSts2(List<String> serviceIds) Get image upload sts2 auth with default expire time (1 hour).
SecurityToken2	getUploadSts2WithExpire(List<String> serviceIds, long expire) Get image upload sts2 auth.
SecurityToken2	getUploadSts2WithKeyPtn(List<String> serviceIds, long expire, String keyPtn) Get image upload sts2 auth.
String	getUploadToken(Map<String,String> params) Get image upload token.
CommonResponse	postImageX(String action, Map<String,String> param, Object req) Request ImageX api with method POST.
UpdateImageFilesResponse	updateImageUrls(UpdateImageFilesRequest req) Update image urls.
CommitImageUploadResponse	uploadImages(ApplyImageUploadRequest request, List<byte[]> imageDatas) Upload image data.

Methods inherited from class com.volcengine.service.BaseServiceImpl

getAccessKey, getApiInfoList, getHttpClient, getISigner, getRegion, getSecretKey, getServiceInfo, getSessionToken, getSignUrl, json, post, put, putData, putDataWithResponse, query, setAccessKey, setClientNoReuse, setConnectionTimeout, setHost, setHttpClient, setRegion, setScheme, setSecretKey, setServiceInfo, setSessionToken, setSocketTimeout, signSts2

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.volcengine.service.IBaseService

getAccessKey, getRegion, getSecretKey, getSessionToken, getSignUrl, json, post, put, putData, query, setAccessKey, setClientNoReuse, setConnectionTimeout, setHost, setHttpClient, setRegion, setScheme, setSecretKey, setServiceInfo, setSessionToken, setSocketTimeout, signSts2

Method Detail

getInstance

public static IImageXService getInstance()

getInstance

public static IImageXService getInstance(String region)
                                  throws Exception

Throws:

Exception

applyImageUpload

public ApplyImageUploadResponse applyImageUpload(ApplyImageUploadRequest req)
                                          throws Exception

Description copied from interface: IImageXService

Apply upload image.

Specified by:

applyImageUpload in interface IImageXService

Parameters:

req - the apply upload request

Returns:

the apply upload response

Throws:

Exception - the exception

commitImageUpload

public CommitImageUploadResponse commitImageUpload(CommitImageUploadRequest req)
                                            throws Exception

Description copied from interface: IImageXService

Commit upload image.

Specified by:

commitImageUpload in interface IImageXService

Parameters:

req - the commit upload request

Returns:

the commit upload response

Throws:

Exception - the exception

uploadImages

public CommitImageUploadResponse uploadImages(ApplyImageUploadRequest request,
                                              List<byte[]> imageDatas)
                                       throws Exception

Description copied from interface: IImageXService

Upload image data.

Specified by:

uploadImages in interface IImageXService

Parameters:

request - the apply upload request

imageDatas - image data array

Returns:

the commit upload response

Throws:

Exception - the exception

getUploadToken

public String getUploadToken(Map<String,String> params)
                      throws Exception

Description copied from interface: IImageXService

Get image upload token.

Specified by:

getUploadToken in interface IImageXService

Parameters:

params - the params

Returns:

the upload token

Throws:

Exception - the exception

getUploadSts2

public SecurityToken2 getUploadSts2(List<String> serviceIds)
                             throws Exception

Description copied from interface: IImageXService

Get image upload sts2 auth with default expire time (1 hour).

Specified by:

getUploadSts2 in interface IImageXService

Parameters:

serviceIds - service id list allowed to upload image to

Returns:

the upload sts2 auth

Throws:

Exception - the exception

getUploadSts2WithExpire

public SecurityToken2 getUploadSts2WithExpire(List<String> serviceIds,
                                              long expire)
                                       throws Exception

Description copied from interface: IImageXService

Get image upload sts2 auth.

Specified by:

getUploadSts2WithExpire in interface IImageXService

Parameters:

serviceIds - service id list allowed to upload image to

expire - expire time in milliseconds

Returns:

the upload sts2 auth

Throws:

Exception - the exception

getUploadSts2WithKeyPtn

public SecurityToken2 getUploadSts2WithKeyPtn(List<String> serviceIds,
                                              long expire,
                                              String keyPtn)
                                       throws Exception

Description copied from interface: IImageXService

Get image upload sts2 auth.

Specified by:

getUploadSts2WithKeyPtn in interface IImageXService

Parameters:

serviceIds - service id list allowed to upload image to

expire - expire time in milliseconds

keyPtn - upload store key pattern, * for no restriction. default to empty.

Returns:

the upload sts2 auth

Throws:

Exception - the exception

deleteImages

public DeleteImageResp deleteImages(DeleteImageReq req)
                             throws Exception

Description copied from interface: IImageXService

Delete images.

Specified by:

deleteImages in interface IImageXService

Parameters:

req - delete image req

Returns:

delete image resp

Throws:

Exception - the exception

updateImageUrls

public UpdateImageFilesResponse updateImageUrls(UpdateImageFilesRequest req)
                                         throws Exception

Description copied from interface: IImageXService

Update image urls.

Specified by:

updateImageUrls in interface IImageXService

Parameters:

req - update image urls req

Returns:

udpate image urls resp

Throws:

Exception - the exception

getImageX

public CommonResponse getImageX(String action,
                                Map<String,String> param)
                         throws Exception

Description copied from interface: IImageXService

Request ImageX api with method GET.

Specified by:

getImageX in interface IImageXService

Parameters:

action - api action name

param - api query param

Returns:

api response

Throws:

Exception - the exception

postImageX

public CommonResponse postImageX(String action,
                                 Map<String,String> param,
                                 Object req)
                          throws Exception

Description copied from interface: IImageXService

Request ImageX api with method POST.

Specified by:

postImageX in interface IImageXService

Parameters:

action - api action name

param - api query param

req - api json param

Returns:

api response

Throws:

Exception - the exception

getImageOCR

public GetImageOCRResponse getImageOCR(Map<String,String> param)
                                throws Exception

Description copied from interface: IImageXService

Request ImageX api with method POST.

Specified by:

getImageOCR in interface IImageXService

Parameters:

param - api query param

Returns:

api response

Throws:

Exception - the exception

embedImageHm

public EmbedImageHmResponse embedImageHm(EmbedImageHmRequest req)
                                  throws Exception

Description copied from interface: IImageXService

Request ImageX api with method POST.

Specified by:

embedImageHm in interface IImageXService

Parameters:

req - embed image hm request

Returns:

image store uri

Throws:

Exception - the exception

extractImageHm

public ExtractImageHmResponse extractImageHm(ExtractImageHmRequest req)
                                      throws Exception

Description copied from interface: IImageXService

Request ImageX api with method POST.

Specified by:

extractImageHm in interface IImageXService

Parameters:

req - extract hidden mark from image

Returns:

embedded info

Throws:

Exception - the exception

getImageSegment

public GetImageSegmentResponse getImageSegment(GetImageSegmentRequest req)
                                        throws Exception

Description copied from interface: IImageXService

Request ImageX api with method POST.

Specified by:

getImageSegment in interface IImageXService

Parameters:

req - get image segment request

Returns:

image store uri

Throws:

Exception - the exception