forked from apache/cloudstack
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
CLOUDSTACK-9957 Annotations (apache#2181)
* annotations on hosts * Adding marvin tests * rebase error * review comments * context for owner * review * illegal entity test * entityType check on input * Annotation events * rebase issues
- Loading branch information
1 parent
189b0e4
commit a379230
Showing
24 changed files
with
1,215 additions
and
67 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| // 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 org.apache.cloudstack.annotation; | ||
|
|
||
| import org.apache.cloudstack.api.Identity; | ||
| import org.apache.cloudstack.api.InternalIdentity; | ||
|
|
||
| import java.util.Date; | ||
|
|
||
| public interface Annotation extends InternalIdentity, Identity { | ||
|
|
||
| String getAnnotation(); | ||
|
|
||
| String getEntityUuid(); | ||
|
|
||
| AnnotationService.EntityType getEntityType(); | ||
|
|
||
| String getUserUuid(); | ||
|
|
||
| Date getCreated(); | ||
|
|
||
| Date getRemoved(); | ||
| } |
49 changes: 49 additions & 0 deletions
49
api/src/org/apache/cloudstack/annotation/AnnotationService.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| // 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 org.apache.cloudstack.annotation; | ||
|
|
||
| import org.apache.cloudstack.api.command.admin.annotation.AddAnnotationCmd; | ||
| import org.apache.cloudstack.api.command.admin.annotation.ListAnnotationsCmd; | ||
| import org.apache.cloudstack.api.command.admin.annotation.RemoveAnnotationCmd; | ||
| import org.apache.cloudstack.api.response.AnnotationResponse; | ||
| import org.apache.cloudstack.api.response.ListResponse; | ||
|
|
||
| public interface AnnotationService { | ||
| ListResponse<AnnotationResponse> searchForAnnotations(ListAnnotationsCmd cmd); | ||
|
|
||
| AnnotationResponse addAnnotation(AddAnnotationCmd addAnnotationCmd); | ||
| AnnotationResponse addAnnotation(String text, EntityType type, String uuid); | ||
|
|
||
| AnnotationResponse removeAnnotation(RemoveAnnotationCmd removeAnnotationCmd); | ||
|
|
||
| enum EntityType { | ||
| HOST("host"), DOMAIN("domain"), VM("vm_instance"); | ||
| private String tableName; | ||
|
|
||
| EntityType(String tableName) { | ||
| this.tableName = tableName; | ||
| } | ||
| static public boolean contains(String representation) { | ||
| try { | ||
| /* EntityType tiep = */ valueOf(representation); | ||
| return true; | ||
| } catch (IllegalArgumentException iae) { | ||
| return false; | ||
| } | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
80 changes: 80 additions & 0 deletions
80
api/src/org/apache/cloudstack/api/command/admin/annotation/AddAnnotationCmd.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,80 @@ | ||
| // 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 org.apache.cloudstack.api.command.admin.annotation; | ||
|
|
||
| import com.cloud.exception.ConcurrentOperationException; | ||
| import com.cloud.exception.InsufficientCapacityException; | ||
| import com.cloud.exception.NetworkRuleConflictException; | ||
| import com.cloud.exception.ResourceAllocationException; | ||
| import com.cloud.exception.ResourceUnavailableException; | ||
| import com.google.common.base.Preconditions; | ||
| import org.apache.cloudstack.acl.RoleType; | ||
| import org.apache.cloudstack.annotation.AnnotationService; | ||
| import org.apache.cloudstack.api.APICommand; | ||
| import org.apache.cloudstack.api.ApiConstants; | ||
| import org.apache.cloudstack.api.BaseCmd; | ||
| import org.apache.cloudstack.api.Parameter; | ||
| import org.apache.cloudstack.api.ServerApiException; | ||
| import org.apache.cloudstack.api.response.AnnotationResponse; | ||
| import org.apache.cloudstack.context.CallContext; | ||
|
|
||
| @APICommand(name = AddAnnotationCmd.APINAME, description = "add an annotation.", responseObject = AnnotationResponse.class, | ||
| requestHasSensitiveInfo = false, responseHasSensitiveInfo = false, since = "4.11", authorized = {RoleType.Admin}) | ||
| public class AddAnnotationCmd extends BaseCmd { | ||
|
|
||
| public static final String APINAME = "addAnnotation"; | ||
|
|
||
| @Parameter(name = ApiConstants.ANNOTATION, type = CommandType.STRING, description = "the annotation text") | ||
| private String annotation; | ||
| @Parameter(name = ApiConstants.ENTITY_TYPE, type = CommandType.STRING, description = "the entity type (only HOST is allowed atm)") | ||
| private String entityType; | ||
| @Parameter(name = ApiConstants.ENTITY_ID, type = CommandType.STRING, description = "the id of the entity to annotate") | ||
| private String entityUuid; | ||
|
|
||
| public String getAnnotation() { | ||
| return annotation; | ||
| } | ||
|
|
||
| public AnnotationService.EntityType getEntityType() { | ||
| return AnnotationService.EntityType.valueOf(entityType); | ||
| } | ||
|
|
||
| public String getEntityUuid() { | ||
| return entityUuid; | ||
| } | ||
|
|
||
| @Override | ||
| public void execute() | ||
| throws ResourceUnavailableException, InsufficientCapacityException, ServerApiException, ConcurrentOperationException, ResourceAllocationException, | ||
| NetworkRuleConflictException { | ||
| Preconditions.checkNotNull(entityUuid,"I have to have an entity to set an annotation on!"); | ||
| Preconditions.checkState(AnnotationService.EntityType.contains(entityType),(java.lang.String)"'%s' is ot a valid EntityType to put annotations on", entityType); | ||
| AnnotationResponse annotationResponse = annotationService.addAnnotation(this); | ||
| annotationResponse.setResponseName(getCommandName()); | ||
| this.setResponseObject(annotationResponse); | ||
| } | ||
|
|
||
| @Override | ||
| public String getCommandName() { | ||
| return APINAME.toLowerCase() + BaseCmd.RESPONSE_SUFFIX; | ||
| } | ||
|
|
||
| @Override | ||
| public long getEntityOwnerId() { | ||
| return CallContext.current().getCallingAccount().getAccountId(); | ||
| } | ||
| } |
81 changes: 81 additions & 0 deletions
81
api/src/org/apache/cloudstack/api/command/admin/annotation/ListAnnotationsCmd.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,81 @@ | ||
| // 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 org.apache.cloudstack.api.command.admin.annotation; | ||
|
|
||
| import com.cloud.exception.ConcurrentOperationException; | ||
| import com.cloud.exception.InsufficientCapacityException; | ||
| import com.cloud.exception.NetworkRuleConflictException; | ||
| import com.cloud.exception.ResourceAllocationException; | ||
| import com.cloud.exception.ResourceUnavailableException; | ||
| import com.cloud.utils.StringUtils; | ||
| import com.google.common.base.Preconditions; | ||
| import org.apache.cloudstack.acl.RoleType; | ||
| import org.apache.cloudstack.api.APICommand; | ||
| import org.apache.cloudstack.api.ApiConstants; | ||
| import org.apache.cloudstack.api.BaseCmd; | ||
| import org.apache.cloudstack.api.BaseListCmd; | ||
| import org.apache.cloudstack.api.Parameter; | ||
| import org.apache.cloudstack.api.ServerApiException; | ||
| import org.apache.cloudstack.api.response.AnnotationResponse; | ||
| import org.apache.cloudstack.api.response.ListResponse; | ||
|
|
||
| @APICommand(name = ListAnnotationsCmd.APINAME, description = "Lists annotations.", responseObject = AnnotationResponse.class, | ||
| requestHasSensitiveInfo = false, responseHasSensitiveInfo = false, since = "4.11", authorized = {RoleType.Admin}) | ||
| public class ListAnnotationsCmd extends BaseListCmd { | ||
|
|
||
| public static final String APINAME = "listAnnotations"; | ||
|
|
||
| @Parameter(name = ApiConstants.ID, type = CommandType.STRING, description = "the id of the annotation") | ||
| private String uuid; | ||
| @Parameter(name = ApiConstants.ENTITY_TYPE, type = CommandType.STRING, description = "the entity type") | ||
| private String entityType; | ||
| @Parameter(name = ApiConstants.ENTITY_ID, type = CommandType.STRING, description = "the id of the entity for which to show annotations") | ||
| private String entityUuid; | ||
|
|
||
| public String getUuid() { | ||
| return uuid; | ||
| } | ||
|
|
||
| public String getEntityType() { | ||
| return entityType; | ||
| } | ||
|
|
||
| public String getEntityUuid() { | ||
| return entityUuid; | ||
| } | ||
|
|
||
| @Override public void execute() | ||
| throws ResourceUnavailableException, InsufficientCapacityException, ServerApiException, ConcurrentOperationException, ResourceAllocationException, | ||
| NetworkRuleConflictException { | ||
| // preconditions to check: | ||
| // if entity type is null entity uuid can not have a value | ||
| Preconditions.checkArgument(StringUtils.isNotBlank(entityType) ? ! StringUtils.isNotBlank(uuid) : true, | ||
| "I can search for an anotation on an entity or for a specific annotation, not both"); | ||
| // if uuid has a value entity type and entity uuid can not have a value | ||
| Preconditions.checkArgument(StringUtils.isNotBlank(uuid) ? entityType == null && entityUuid == null : true, | ||
| "I will either search for a specific annotation or for annotations on an entity, not both"); | ||
|
|
||
| ListResponse<AnnotationResponse> response = annotationService.searchForAnnotations(this); | ||
| response.setResponseName(getCommandName()); | ||
| this.setResponseObject(response); | ||
| response.setObjectName("annotations"); | ||
| } | ||
|
|
||
| @Override public String getCommandName() { | ||
| return APINAME.toLowerCase() + BaseCmd.RESPONSE_SUFFIX; | ||
| } | ||
| } |
Oops, something went wrong.