dmaap-bc/src/main/java/org/onap/dmaap/dbcapi/resources/TopicResource.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * org.onap.dmaap
   4  * ================================================================================
   5  * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.dmaap.dbcapi.resources;
  22
  23 import io.swagger.annotations.Api;
  24 import io.swagger.annotations.ApiOperation;
  25 import io.swagger.annotations.ApiResponse;
  26 import io.swagger.annotations.ApiResponses;
  27
  28 import java.util.List;
  29
  30 import javax.ws.rs.Consumes;
  31 import javax.ws.rs.DELETE;
  32 import javax.ws.rs.GET;
  33 import javax.ws.rs.POST;
  34 import javax.ws.rs.PUT;
  35 import javax.ws.rs.Path;
  36 import javax.ws.rs.PathParam;
  37 import javax.ws.rs.Produces;
  38 import javax.ws.rs.QueryParam;
  39 import javax.ws.rs.core.GenericEntity;
  40 import javax.ws.rs.core.MediaType;
  41 import javax.ws.rs.core.Response;
  42 import javax.ws.rs.core.Response.Status;
  43
  44 import org.onap.dmaap.dbcapi.logging.BaseLoggingClass;
  45 import org.onap.dmaap.dbcapi.model.ApiError;
  46 import org.onap.dmaap.dbcapi.model.ReplicationType;
  47 import org.onap.dmaap.dbcapi.model.FqtnType;
  48 import org.onap.dmaap.dbcapi.model.Topic;
  49 import org.onap.dmaap.dbcapi.service.TopicService;
  50 import org.onap.dmaap.dbcapi.util.DmaapConfig;
  51
  52 import static javax.ws.rs.core.Response.Status.CREATED;
  53
  54 @Path("/topics")
  55 @Api( value= "topics", description = "Endpoint for retreiving MR Topics" )
  56 @Consumes(MediaType.APPLICATION_JSON)
  57 @Produces(MediaType.APPLICATION_JSON)
  58 @Authorization
  59 public class TopicResource extends BaseLoggingClass {
  60         private static FqtnType defaultTopicStyle;
  61         private static String defaultPartitionCount;
  62         private static String defaultReplicationCount;
  63         private TopicService mr_topicService = new TopicService();
  64         private ResponseBuilder responseBuilder = new ResponseBuilder();
  65         private RequiredChecker checker = new RequiredChecker();
  66         static final String UNSUPPORTED_PUT_MSG = "Method /PUT not supported for /topics";
  67
  68         public TopicResource() {
  69                 DmaapConfig p = (DmaapConfig)DmaapConfig.getConfig();
  70                 defaultTopicStyle = FqtnType.Validator( p.getProperty("MR.topicStyle", "FQTN_LEGACY_FORMAT"));
  71                 defaultPartitionCount = p.getProperty( "MR.partitionCount", "2");
  72                 defaultReplicationCount = p.getProperty( "MR.replicationCount", "1");
  73
  74                 logger.info( "Setting defaultTopicStyle=" + defaultTopicStyle );
  75         }
  76
  77         @GET
  78         @ApiOperation( value = "return Topic details",
  79         notes = "Returns array of  `Topic` objects.",
  80         response = Topic.class)
  81         @ApiResponses( value = {
  82             @ApiResponse( code = 200, message = "Success", response = Topic.class),
  83             @ApiResponse( code = 400, message = "Error", response = ApiError.class )
  84         })
  85         public Response getTopics() {
  86                 List<Topic> allTopics = mr_topicService.getAllTopics();
  87
  88                 GenericEntity<List<Topic>> list = new GenericEntity<List<Topic>>(allTopics) {
  89                         };
  90                 return responseBuilder.success(list);
  91
  92         }
  93
  94         @POST
  95         @ApiOperation( value = "Create a Topic object",
  96         notes = "Create  `Topic` object."
  97                         + "For convenience, the message body may populate the `clients` array, in which case each entry will be added as an `MR_Client`."
  98                         + "  Beginning in ONAP Dublin Release, dbcapi will create two AAF Roles by default, one each for the publisher and subscriber per topic."
  99                         + "  MR_Clients can then specify an AAF Identity to be added to the appropriate default Role, avoiding the need to create Role(s) in advance.",
 100         response = Topic.class)
 101         @ApiResponses( value = {
 102             @ApiResponse( code = 200, message = "Success", response = Topic.class),
 103             @ApiResponse( code = 400, message = "Error", response = ApiError.class )
 104         })
 105         public Response  addTopic(Topic topic, @QueryParam("useExisting") String useExisting) {
 106                 logger.info( "addTopic request: " + topic  + " useExisting=" + useExisting );
 107                 ApiError apiError = new ApiError();
 108
 109                 try {
 110                         checker.required( "topicName", topic.getTopicName(), "^\\S+$" );  //no white space allowed in topicName
 111                         checker.required( "topicDescription", topic.getTopicDescription());
 112                         checker.required( "owner", topic.getOwner());
 113                 } catch( RequiredFieldException rfe ) {
 114                         logger.error("Error", rfe.getApiError());
 115                         return responseBuilder.error(rfe.getApiError());
 116                 }
 117
 118                 ReplicationType t = topic.getReplicationCase();
 119                 if ( t == null || t == ReplicationType.REPLICATION_NOT_SPECIFIED ) {
 120                         topic.setReplicationCase( mr_topicService.reviewTopic(topic));
 121                 }
 122                 FqtnType ft = topic.getFqtnStyle();
 123                 if ( ft == null || ft == FqtnType.FQTN_NOT_SPECIFIED ) {
 124                         logger.info( "setting defaultTopicStyle=" + defaultTopicStyle + " for topic " + topic.getTopicName() );
 125                         topic.setFqtnStyle( defaultTopicStyle );
 126                 }
 127                 String pc = topic.getPartitionCount();
 128                 if ( pc == null ) {
 129                         topic.setPartitionCount(defaultPartitionCount);
 130                 }
 131                 String rc = topic.getReplicationCount();
 132                 if ( rc == null ) {
 133                         topic.setReplicationCount(defaultReplicationCount);
 134                 }
 135                 topic.setLastMod();
 136                 Boolean flag = false;
 137                 if (useExisting != null) {
 138                         flag = "true".compareToIgnoreCase( useExisting ) == 0;
 139                 }
 140
 141                 Topic mrc =  mr_topicService.addTopic(topic, apiError, flag);
 142                 if ( mrc != null && apiError.is2xx() ) {
 143                         return responseBuilder.success(CREATED.getStatusCode(), mrc);
 144                 }
 145                 return responseBuilder.error(apiError);
 146         }
 147
 148         @PUT
 149         @ApiOperation( value = "return Topic details",
 150         notes = "Update a  `Topic` object, identified by topicId",
 151         response = Topic.class)
 152         @ApiResponses( value = {
 153             @ApiResponse( code = 200, message = "Success", response = Topic.class),
 154             @ApiResponse( code = 400, message = "Error", response = ApiError.class )
 155         })
 156         @Path("/{topicId}")
 157         public Response updateTopic(@PathParam("topicId") String topicId) {
 158                 ApiError apiError = new ApiError();
 159
 160                 apiError.setCode(Status.BAD_REQUEST.getStatusCode());
 161                 apiError.setMessage(UNSUPPORTED_PUT_MSG);
 162
 163                 return responseBuilder.error(apiError);
 164         }
 165
 166         @DELETE
 167         @ApiOperation( value = "return Topic details",
 168         notes = "Delete a  `Topic` object, identified by topicId",
 169         response = Topic.class)
 170         @ApiResponses( value = {
 171             @ApiResponse( code = 204, message = "Success", response = Topic.class),
 172             @ApiResponse( code = 400, message = "Error", response = ApiError.class )
 173         })
 174         @Path("/{topicId}")
 175         public Response deleteTopic(@PathParam("topicId") String id){
 176                 ApiError apiError = new ApiError();
 177
 178                 try {
 179                         checker.required( "fqtn", id);
 180                 } catch( RequiredFieldException rfe ) {
 181                         logger.error("Error", rfe.getApiError());
 182                         return responseBuilder.error(rfe.getApiError());
 183                 }
 184
 185                 mr_topicService.removeTopic(id, apiError);
 186                 if (apiError.is2xx()) {
 187                         return responseBuilder.success(Status.NO_CONTENT.getStatusCode(), null);
 188                 }
 189                 return responseBuilder.error(apiError);
 190         }
 191
 192
 193         @GET
 194         @ApiOperation( value = "return Topic details",
 195         notes = "Retrieve a  `Topic` object, identified by topicId",
 196         response = Topic.class)
 197         @ApiResponses( value = {
 198             @ApiResponse( code = 200, message = "Success", response = Topic.class),
 199             @ApiResponse( code = 400, message = "Error", response = ApiError.class )
 200         })
 201         @Path("/{topicId}")
 202         public Response getTopic(@PathParam("topicId") String id) {
 203                 logger.info("Entry: /GET " + id);
 204                 ApiError apiError = new ApiError();
 205
 206                 try {
 207                         checker.required( "topicName", id, "^\\S+$" );  //no white space allowed in topicName
 208                 } catch( RequiredFieldException rfe ) {
 209                         logger.error("Error", rfe.getApiError());
 210                         return responseBuilder.error(rfe.getApiError());
 211                 }
 212                 Topic mrc =  mr_topicService.getTopic(id, apiError);
 213                 if ( mrc == null ) {
 214                         return responseBuilder.error(apiError);
 215                 }
 216                 return responseBuilder.success(mrc);
 217                 }
 218 }