aai-core/src/main/java/org/openecomp/aai/parsers/uri/Parsable.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * org.openecomp.aai
   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.openecomp.aai.parsers.uri;
  22
  23 import javax.ws.rs.core.MultivaluedMap;
  24
  25 import org.openecomp.aai.exceptions.AAIException;
  26 import org.openecomp.aai.introspection.Introspector;
  27 import org.openecomp.aai.serialization.db.EdgeType;
  28
  29 /**
  30  * The Interface Parsable.
  31  */
  32 public interface Parsable {
  33
  34         /**
  35          *
  36          * @param obj
  37          * @param type
  38          * @param uriKeys
  39          * @throws AAIException
  40          */
  41         public void processObject(Introspector obj, EdgeType type, MultivaluedMap<String, String> uriKeys) throws AAIException;
  42         /**
  43          * Process container.
  44          *
  45          * @param obj the obj
  46          * @param uriKeys the uri keys
  47          * @param isFinalContainer the is final container
  48          * @throws AAIException the AAI exception
  49          */
  50         public void processContainer(Introspector obj, EdgeType type, MultivaluedMap<String, String> uriKeys, boolean isFinalContainer) throws AAIException;
  51
  52         /**
  53          * Process namespace.
  54          *
  55          * @param obj the obj
  56          */
  57         public void processNamespace(Introspector obj);
  58
  59         /**
  60          * Gets the cloud region transform.
  61          *
  62          * @return the cloud region transform
  63          */
  64         public String getCloudRegionTransform();
  65
  66         /**
  67          * Use original loader.
  68          *
  69          * @return true, if successful
  70          */
  71         public boolean useOriginalLoader();
  72 }