com.aliyun.odps.Resource Maven / Gradle / Ivy
The newest version!
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package com.aliyun.odps;
import java.util.Collections;
import java.util.Date;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import com.aliyun.odps.commons.transport.Headers;
import com.aliyun.odps.commons.transport.Response;
import com.aliyun.odps.commons.util.DateUtils;
import com.aliyun.odps.rest.ResourceBuilder;
import com.aliyun.odps.rest.RestClient;
import com.aliyun.odps.rest.SimpleXmlUtils;
import com.aliyun.odps.simpleframework.xml.Element;
import com.aliyun.odps.simpleframework.xml.Root;
import com.aliyun.odps.simpleframework.xml.convert.Convert;
import com.aliyun.odps.utils.NameSpaceSchemaUtils;
import com.aliyun.odps.utils.TagUtils;
import com.aliyun.odps.utils.TagUtils.OBJECT_TYPE;
import com.aliyun.odps.utils.TagUtils.OPERATION_TYPE;
import com.aliyun.odps.utils.TagUtils.ObjectRef;
import com.aliyun.odps.utils.TagUtils.ObjectTagInfo;
import com.aliyun.odps.utils.TagUtils.SetObjectTagInput;
import com.aliyun.odps.utils.TagUtils.SimpleTag;
import com.aliyun.odps.utils.TagUtils.TagRef;
import com.aliyun.odps.utils.StringUtils;
/**
* Resource表示ODPS中的资源
*
* @author [email protected]
*/
public class Resource extends LazyLoad {
/**
* 表示ODPS中资源的类型
*
* @author [email protected]
*/
public enum Type {
/**
* 文件类型资源
*/
FILE,
/**
* JAR类型资源
*/
JAR,
/**
* PY类型资源
*/
PY,
/**
* ARCHIVE类型资源。ODPS通过资源名称中的后缀识别压缩类型，支持的压缩文件类型包括：.zip/.tgz/.tar.gz/.tar/.jar。
*/
ARCHIVE,
/**
* 表类型资源
*/
TABLE,
VOLUMEFILE,
VOLUMEARCHIVE,
/**
* 用户设置的或系统暂不支持的资源类型
*/
UNKOWN
}
/**
* Resource model
*/
@Root(name = "Resource", strict = false)
static class ResourceModel {
@Element(name = "SchemaName", required = false)
@Convert(SimpleXmlUtils.EmptyStringConverter.class)
String schemaName;
@Element(name = "Name", required = false)
@Convert(SimpleXmlUtils.EmptyStringConverter.class)
String name;
@Element(name = "Owner", required = false)
@Convert(SimpleXmlUtils.EmptyStringConverter.class)
String owner;
@Element(name = "Comment", required = false)
@Convert(SimpleXmlUtils.EmptyStringConverter.class)
String comment;
@Element(name = "ResourceType", required = false)
@Convert(SimpleXmlUtils.EmptyStringConverter.class)
String type;
@Element(name = "CreationTime", required = false)
@Convert(SimpleXmlUtils.DateConverter.class)
Date createdTime;
@Element(name = "LastModifiedTime", required = false)
@Convert(SimpleXmlUtils.DateConverter.class)
Date lastModifiedTime;
@Element(name = "LastUpdator", required = false)
@Convert(SimpleXmlUtils.EmptyStringConverter.class)
String lastUpdator;
@Element(name = "ResourceSize", required = false)
Long size;
@Element(name = "TableName", required = false)
@Convert(SimpleXmlUtils.EmptyStringConverter.class)
String sourceTableName;
String contentMD5;
boolean isTempResource;
String volumePath;
}
ResourceModel model;
private ObjectTagInfo resourceTagInfo;
String project;
RestClient client;
Odps odps;
/**
* 创建Resource类的对象
*/
public Resource() {
model = new ResourceModel();
}
Resource(ResourceModel model, String project, Odps odps) {
this.model = model;
this.project = project;
this.odps = odps;
this.client = odps.getRestClient();
}
/**
* Create a resource instance from the given full name.
*
* @param defaultProjectName
* Cannot be null. Default project name if the full name doesn't contain a project name.
* @param fullName
* Cannot be null. Possible patterns:
*
* /resources/
* /schemas//resources/
* @return A {@link Resource} instance.
*/
static Resource from(String defaultProjectName, String fullName, Odps odps) {
if (StringUtils.isNullOrEmpty(fullName)) {
throw new IllegalArgumentException("Argument 'fullName' cannot be null or empty");
}
String projectName = defaultProjectName;
ResourceModel model = new ResourceModel();
String[] parts = fullName.split("/");
if (parts.length == 1) {
model.name = parts[0];
} else if (parts.length == 3) {
if ("resources".equalsIgnoreCase(parts[1])) {
projectName = parts[0];
model.name = parts[2];
} else {
throw new IllegalArgumentException("Invalid resource full name");
}
} else if (parts.length == 5) {
if ("schemas".equalsIgnoreCase(parts[1]) && "resources".equalsIgnoreCase(parts[3])) {
projectName = parts[0];
model.schemaName = parts[2];
model.name = parts[4];
} else {
throw new IllegalArgumentException("Invalid resource full name");
}
} else {
throw new IllegalArgumentException("Invalid resource full name");
}
return new Resource(model, projectName, odps);
}
static Resource createResource(Type type) {
Resource resource;
switch (type) {
case ARCHIVE:
resource = new ArchiveResource();
break;
case FILE:
resource = new FileResource();
break;
case JAR:
resource = new JarResource();
break;
case PY:
resource = new PyResource();
break;
case TABLE:
resource = new TableResource();
break;
case VOLUMEFILE:
resource = new VolumeFileResource();
break;
case VOLUMEARCHIVE:
resource = new VolumeArchiveResource();
break;
case UNKOWN:
resource = new Resource();
break;
default:
resource = new Resource();
}
return resource;
}
static Resource getResource(ResourceModel model, String project, Odps odps) {
if (model.type == null) {
Resource resource = new Resource(model, project, odps);
try {
resource.reload();
model = resource.model;
} catch (OdpsException e) {
return resource;
}
}
Type type = Type.valueOf(model.type.toUpperCase());
Resource resource = createResource(type);
resource.model = model;
resource.project = project;
resource.odps = odps;
resource.client = odps.getRestClient();
return resource;
}
/**
* 获得资源名称
*
* @return 资源名称
*/
public String getName() {
if (model.name == null && client != null) {
lazyLoad();
}
return model.name;
}
/**
* 设置资源名称
*
* @param name
* 资源名称
*/
public void setName(String name) {
// TODO: replace with a static builder
model.name = name;
}
/**
* 获取资源注释信息
*
* @return 注释信息
*/
public String getComment() {
if (model.comment == null && client != null) {
lazyLoad();
}
return model.comment;
}
/**
* 设置资源注释信息
*
* @param comment
* 注释信息
*/
public void setComment(String comment) {
// TODO: replace with a static builder
model.comment = comment;
}
/**
* 获取资源所属用户
*
* @return 用户名
*/
public String getOwner() {
if (model.owner == null && client != null) {
lazyLoad();
}
return model.owner;
}
/**
* 获取资源类型
*
* @return 资源类型
*/
public Type getType() {
if (model.type == null && client != null) {
lazyLoad();
}
if (model.type == null) {
return Type.UNKOWN;
}
try {
return Type.valueOf(model.type.toUpperCase());
} catch (IllegalArgumentException e) {
return Type.UNKOWN;
}
}
/**
* 获取资源创建时间
*
* @return 创建时间
*/
public Date getCreatedTime() {
if (model.createdTime == null && client != null) {
lazyLoad();
}
return model.createdTime;
}
/**
* 获取资源最后修改时间
*
* @return 最后修改时间
*/
public Date getLastModifiedTime() {
if (model.lastModifiedTime == null && client != null) {
lazyLoad();
}
return model.lastModifiedTime;
}
/**
* 获得资源最后更新者
*
* @return 资源最后更新者
*/
public String getLastUpdator() {
if (model.lastUpdator == null && client != null) {
lazyLoad();
}
return model.lastUpdator;
}
/**
* 获得资源大小
*
* 注意: 表 和 volumn 返回 null
* @return 资源大小
*/
public Long getSize() {
if (model.size == null && client != null) {
lazyLoad();
}
return model.size;
}
/**
* 获取资源所在{@link Project}名称
*
* @return Project名称
*/
public String getProject() {
return project;
}
/**
* Get the schema name. This method lazy loads the resource information, and a
* {@link ReloadException} will be thrown if lazy loading failed.
*
* @return The schema name.
*/
public String getSchemaName() {
lazyLoad();
return model.schemaName;
}
@Override
public void reload() throws OdpsException {
String resource = ResourceBuilder.buildResourceResource(project, model.name);
HashMap params = NameSpaceSchemaUtils.initParamsWithSchema(model.schemaName);
params.put("meta", null);
Response rp = client.request(resource, "GET", params, null, null);
Map headers = rp.getHeaders();
model.owner = headers.get(Headers.ODPS_OWNER);
model.type = headers.get(Headers.ODPS_RESOURCE_TYPE);
model.comment = headers.get(Headers.ODPS_COMMENT);
model.lastUpdator = headers.get(Headers.ODPS_RESOURCE_LAST_UPDATOR);
model.schemaName = headers.get(Headers.SCHEMA_NAME);
String sizeStr = headers.get(Headers.ODPS_RESOURCE_SIZE);
try {
model.size = (sizeStr == null ? null : Long.parseLong(sizeStr));
} catch (NumberFormatException e) {
throw new OdpsException("Invalid resource size format" + sizeStr, e);
}
try {
model.createdTime = DateUtils.parseRfc822Date(headers
.get(Headers.ODPS_CREATION_TIME));
model.lastModifiedTime = DateUtils.parseRfc822Date(headers
.get(Headers.LAST_MODIFIED));
} catch (Exception e) {
throw new OdpsException("Invalid date format", e);
}
model.sourceTableName = headers.get(Headers.ODPS_COPY_TABLE_SOURCE);
model.volumePath = headers.get(Headers.ODPS_COPY_FILE_SOURCE);
model.contentMD5 = headers.get(Headers.CONTENT_MD5);
String isTempResourceString = headers.get(Headers.ODPS_RESOURCE_IS_TEMP);
if (!StringUtils.isNullOrEmpty(isTempResourceString)) {
model.isTempResource = Boolean.parseBoolean(isTempResourceString);
}
setLoaded(true);
}
private void reloadTagInfo() {
String resource = ResourceBuilder.buildResourceResource(project, model.name);
// Convert the OdpsException to a ReloadException the keep the consistency of the getter's
// method signature.
try {
resourceTagInfo = TagUtils.getObjectTagInfo(resource, null, client);
} catch (OdpsException e) {
throw new ReloadException(e);
}
}
/**
* 更新 资源的 owner
* 需要是 project owner
*
* @param newOwner
* @throws OdpsException
*/
public void updateOwner(String newOwner) throws OdpsException {
String method = "PUT";
String resource = ResourceBuilder.buildResourceResource(project, model.name);
HashMap params = NameSpaceSchemaUtils.initParamsWithSchema(model.schemaName);
params.put("updateowner", null);
HashMap headers = new HashMap();
headers.put(Headers.ODPS_OWNER, newOwner);
client.request(resource, method, params, headers, null);
model.owner = newOwner;
}
/**
* Get {@link Tag}(s) attached to this resource.
* @return list of {@link Tag}
*/
public List getTags() {
reloadTagInfo();
return TagUtils.getTags(resourceTagInfo, odps);
}
/**
* Get simple tags attached to this resource.
* @return a map from category to key value pairs
*/
public Map> getSimpleTags() {
reloadTagInfo();
return TagUtils.getSimpleTags(resourceTagInfo);
}
/**
* Attach a {@link Tag} to this resource. The resource and tag should be in a same project.
*
* @param tag tag to attach
*/
public void addTag(Tag tag) throws OdpsException {
ObjectRef objectRef = new ObjectRef(
OBJECT_TYPE.RESOURCE,
project,
model.name,
null);
TagRef tagRef = new TagRef(tag.getClassification(), tag.getName());
SetObjectTagInput setObjectTagInput =
new SetObjectTagInput(OPERATION_TYPE.SET, objectRef, tagRef, null);
TagUtils.updateTagInternal(setObjectTagInput, null, client);
}
/**
* Attach a simple tag to this resource. A simple tag is a triad consisted of category, tag key,
* and tag value.
*
* @param category simple tag category, could be nul.
* @param key simple tag key, cannot be null.
* @param value simple tag value, cannot be null.
*/
public void addSimpleTag(
String category,
String key,
String value) throws OdpsException {
ObjectRef objectRef = new ObjectRef(
OBJECT_TYPE.RESOURCE,
project,
model.name,
null);
SimpleTag simpleTag = new SimpleTag(category, Collections.singletonMap(key, value));
SetObjectTagInput setObjectTagInput =
new SetObjectTagInput(OPERATION_TYPE.SET, objectRef, null, simpleTag);
TagUtils.updateTagInternal(setObjectTagInput, null, client);
}
/**
* Remove a {@link Tag}.
*
* @param tag tag to remove.
*/
public void removeTag(Tag tag) throws OdpsException {
Objects.requireNonNull(tag);
ObjectRef objectRef = new ObjectRef(
OBJECT_TYPE.RESOURCE,
project,
model.name,
null);
TagRef tagRef = new TagRef(tag.getClassification(), tag.getName());
SetObjectTagInput setObjectTagInput =
new SetObjectTagInput(OPERATION_TYPE.UNSET, objectRef, tagRef, null);
TagUtils.updateTagInternal(setObjectTagInput, null, client);
}
/**
* Remove a simple tag. A simple tag is a triad consisted of category, tag key, and
* tag value.
*
* @param category category.
* @param key key.
* @param value value.
* @throws OdpsException
*/
public void removeSimpleTag(
String category,
String key,
String value) throws OdpsException {
Objects.requireNonNull(category);
Objects.requireNonNull(key);
Objects.requireNonNull(value);
ObjectRef objectRef = new ObjectRef(
OBJECT_TYPE.RESOURCE,
project,
model.name,
null);
SimpleTag simpleTag = new SimpleTag(category, Collections.singletonMap(key, value));
SetObjectTagInput setObjectTagInput =
new SetObjectTagInput(OPERATION_TYPE.UNSET, objectRef, null, simpleTag);
TagUtils.updateTagInternal(setObjectTagInput, null, client);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy