appc-adapters/appc-iaas-adapter/appc-iaas-adapter-bundle/src/main/java/org/onap/appc/adapter/iaas/impl/VMURL.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP : APPC
   4  * ================================================================================
   5  * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Copyright (C) 2017 Amdocs
   8  * =============================================================================
   9  * Licensed under the Apache License, Version 2.0 (the "License");
  10  * you may not use this file except in compliance with the License.
  11  * You may obtain a copy of the License at
  12  *
  13  *      http://www.apache.org/licenses/LICENSE-2.0
  14  *
  15  * Unless required by applicable law or agreed to in writing, software
  16  * distributed under the License is distributed on an "AS IS" BASIS,
  17  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18  * See the License for the specific language governing permissions and
  19  * limitations under the License.
  20  *
  21  * ECOMP is a trademark and service mark of AT&T Intellectual Property.
  22  * ============LICENSE_END=========================================================
  23  */
  24
  25 package org.onap.appc.adapter.iaas.impl;
  26
  27 import java.util.regex.Matcher;
  28 import java.util.regex.Pattern;
  29
  30 /**
  31  * This class is used to parse the VM URL returned from OpenStack and extract all of the constituent parts.
  32  */
  33 public class VMURL {
  34
  35     /**
  36      * The regular expression pattern used to parse the URL. Capturing groups are used to identify and extract the
  37      * various component parts of the URL.
  38      */
  39     private static Pattern pattern =
  40             Pattern.compile("(\\p{Alnum}+)://([^/:]+)(?::([0-9]+))?(/.*)?/(v[0-9\\.]+)/([^/]+)/servers/([^/]+)");
  41
  42     /**
  43      * The URL scheme or protocol, such as HTTP or HTTPS
  44      */
  45     private String scheme;
  46
  47     /**
  48      * The host name or ip address
  49      */
  50     private String host;
  51
  52     /**
  53      * The path, or null if no path is defined
  54      */
  55     private String path;
  56
  57     /**
  58      * The port number, or null if no port is defined
  59      */
  60     private String port;
  61
  62     /**
  63      * The tenant UUID
  64      */
  65     private String tenantId;
  66
  67     /**
  68      * The server UUID
  69      */
  70     private String serverId;
  71
  72     /**
  73      * The version of the service
  74      */
  75     private String version;
  76
  77     /**
  78      * A private default constructor prevents instantiation by any method other than the factory method
  79      *
  80      * @see #parseURL(String)
  81      */
  82     private VMURL() {
  83
  84     }
  85
  86     /**
  87      * This static method is used to parse the provided server URL string and return a parse results object (VMURL)
  88      * which represents the state of the parse.
  89      *
  90      * @param serverUrl The server URL to be parsed
  91      * @return The VMURL parse results object, or null if the URL was not valid or null.
  92      */
  93     public static VMURL parseURL(String serverUrl) {
  94         VMURL obj = null;
  95         if (serverUrl != null) {
  96             Matcher matcher = pattern.matcher(serverUrl.trim());
  97             if (matcher.matches()) {
  98                 obj = new VMURL();
  99                 obj.scheme = matcher.group(1);
 100                 obj.host = matcher.group(2);
 101                 obj.port = matcher.group(3);
 102                 obj.path = matcher.group(4);
 103                 obj.version = matcher.group(5);
 104                 obj.tenantId = matcher.group(6);
 105                 obj.serverId = matcher.group(7);
 106             }
 107         }
 108
 109         return obj;
 110     }
 111
 112     /**
 113      * @return The URL scheme
 114      */
 115     public String getScheme() {
 116         return scheme;
 117     }
 118
 119     /**
 120      * @return The URL host
 121      */
 122     public String getHost() {
 123         return host;
 124     }
 125
 126     /**
 127      * @return THe URL path, or null if no path was defined
 128      */
 129     public String getPath() {
 130         return path;
 131     }
 132
 133     /**
 134      * @return The URL port, or null if no port was defined
 135      */
 136     public String getPort() {
 137         return port;
 138     }
 139
 140     /**
 141      * @return The tenant id
 142      */
 143     public String getTenantId() {
 144         return tenantId;
 145     }
 146
 147     /**
 148      * @return The server ID
 149      */
 150     public String getServerId() {
 151         return serverId;
 152     }
 153
 154     /**
 155      * @return The version of the service
 156      */
 157     public String getVersion() {
 158         return version;
 159     }
 160
 161     @Override
 162     public String toString() {
 163         StringBuilder str = new StringBuilder();
 164         str.append(scheme + "://" + host);
 165         if (port != null) {
 166             str.append(":" + port);
 167         }
 168         if (path != null) {
 169             str.append(path);
 170         }
 171         str.append("/" + version + "/" + tenantId + "/servers/" + serverId);
 172         return str.toString();
 173     }
 174
 175 }