summaryrefslogtreecommitdiffstats
path: root/adapters/mso-vnf-adapter/README.md
blob: 2085fc90b6d55c2f20faa555681e0b04d26ad32b (plain)
1
2
3
4
5
6
7
8
9
10
11
This artifact is the MSO VNF adapter.  It serves both SOAP and REST requests to the following URLs:

  * http://host:port/vnfs/VnfAdapter?wsdl
  * http://host:port/vnfs/VnfAdapterAsync?wsdl
  * http://host:port/vnfs/rest/v1/vnfs/healthcheck
  * http://host:port/vnfs/rest/v1/vnfs/{aaiVnfId}/vf-modules
  * http://host:port/vnfs/rest/v1/vnfs/{aaiVnfId}/vf-modules/{aaiVfModuleId}
  * http://host:port/vnfs/rest/v1/vnfs/{aaiVnfId}/vf-modules/{aaiVfModuleId}/rollback
  * http://host:port/vnfs/rest/v1/volume-groups
  * http://host:port/vnfs/rest/v1/volume-groups/{aaiVolumeGroupId}
  * http://host:port/vnfs/rest/v1/volume-groups/{aaiVolumeGroupId}/rollback
Name.Property */ .highlight .nt { color: #f92672 } /* Name.Tag */ .highlight .nv { color: #f8f8f2 } /* Name.Variable */ .highlight .ow { color: #f92672 } /* Operator.Word */ .highlight .w { color: #f8f8f2 } /* Text.Whitespace */ .highlight .mb { color: #ae81ff } /* Literal.Number.Bin */ .highlight .mf { color: #ae81ff } /* Literal.Number.Float */ .highlight .mh { color: #ae81ff } /* Literal.Number.Hex */ .highlight .mi { color: #ae81ff } /* Literal.Number.Integer */ .highlight .mo { color: #ae81ff } /* Literal.Number.Oct */ .highlight .sa { color: #e6db74 } /* Literal.String.Affix */ .highlight .sb { color: #e6db74 } /* Literal.String.Backtick */ .highlight .sc { color: #e6db74 } /* Literal.String.Char */ .highlight .dl { color: #e6db74 } /* Literal.String.Delimiter */ .highlight .sd { color: #e6db74 } /* Literal.String.Doc */ .highlight .s2 { color: #e6db74 } /* Literal.String.Double */ .highlight .se { color: #ae81ff } /* Literal.String.Escape */ .highlight .sh { color: #e6db74 } /* Literal.String.Heredoc */ .highlight .si { color: #e6db74 } /* Literal.String.Interpol */ .highlight .sx { color: #e6db74 } /* Literal.String.Other */ .highlight .sr { color: #e6db74 } /* Literal.String.Regex */ .highlight .s1 { color: #e6db74 } /* Literal.String.Single */ .highlight .ss { color: #e6db74 } /* Literal.String.Symbol */ .highlight .bp { color: #f8f8f2 } /* Name.Builtin.Pseudo */ .highlight .fm { color: #a6e22e } /* Name.Function.Magic */ .highlight .vc { color: #f8f8f2 } /* Name.Variable.Class */ .highlight .vg { color: #f8f8f2 } /* Name.Variable.Global */ .highlight .vi { color: #f8f8f2 } /* Name.Variable.Instance */ .highlight .vm { color: #f8f8f2 } /* Name.Variable.Magic */ .highlight .il { color: #ae81ff } /* Literal.Number.Integer.Long */ } @media (prefers-color-scheme: light) { .highlight .hll { background-color: #ffffcc } .highlight .c { color: #888888 } /* Comment */ .highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */ .highlight .k { color: #008800; font-weight: bold } /* Keyword */ .highlight .ch { color: #888888 } /* Comment.Hashbang */ .highlight .cm { color: #888888 } /* Comment.Multiline */ .highlight .cp { color: #cc0000; font-weight: bold } /* Comment.Preproc */ .highlight .cpf { color: #888888 } /* Comment.PreprocFile */ .highlight .c1 { color: #888888 } /* Comment.Single */ .highlight .cs { color: #cc0000; font-weight: bold; background-color: #fff0f0 } /* Comment.Special */ .highlight .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */ .highlight .ge { font-style: italic } /* Generic.Emph */ .highlight .gr { color: #aa0000 } /* Generic.Error */ .highlight .gh { color: #333333 } /* Generic.Heading */ .highlight .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */ .highlight .go { color: #888888 } /* Generic.Output */ .highlight .gp { color: #555555 } /* Generic.Prompt */ .highlight .gs { font-weight: bold } /* Generic.Strong */ .highlight .gu { color: #666666 } /* Generic.Subheading */ .highlight .gt { color: #aa0000 } /* Generic.Traceback */ .highlight .kc { color: #008800; font-weight: bold } /* Keyword.Constant */ .highlight .kd { color: #008800; font-weight: bold } /* Keyword.Declaration */ .highlight .kn { color: #008800; font-weight: bold } /* Keyword.Namespace */ .highlight .kp { color: #008800 } /* Keyword.Pseudo */ .highlight .kr { color: #008800; font-weight: bold } /* Keyword.Reserved */ .highlight .kt { color: #888888; font-weight: bold } /* Keyword.Type */ .highlight .m { color: #0000DD; font-weight: bold } /* Literal.Number */ .highlight .s { color: #dd2200; background-color: #fff0f0 } /* Literal.String */ .highlight .na { color: #336699 } /* Name.Attribute */ .highlight .nb { color: #003388 } /* Name.Builtin */ .highlight .nc { color: #bb0066; font-weight: bold } /* Name.Class */ .highlight .no { color: #003366; font-weight: bold } /* Name.Constant */ .highlight .nd { color: #555555 } /* Name.Decorator */ .highlight .ne { color: #bb0066; font-weight: bold } /* Name.Exception */ .highlight .nf { color: #0066bb; font-weight: bold } /* Name.Function */ .highlight .nl { color: #336699; font-style: italic } /* Name.Label */ .highlight .nn { color: #bb0066; font-weight: bold } /* Name.Namespace */ .highlight .py { color: #336699; font-weight: bold } /* Name.Property */ .highlight .nt { color: #bb0066; font-weight: bold } /* Name.Tag */ .highlight .nv { color: #336699 } /* Name.Variable */ .highlight .ow { color: #008800 } /* Operator.Word */ .highlight .w { color: #bbbbbb } /* Text.Whitespace */ .highlight .mb { color: #0000DD; font-weight: bold } /* Literal.Number.Bin */ .highlight .mf { color: #0000DD; font-weight: bold } /* Literal.Number.Float */ .highlight .mh { color: #0000DD; font-weight: bold } /* Literal.Number.Hex */ .highlight .mi { color: #0000DD; font-weight: bold } /* Literal.Number.Integer */ .highlight .mo { color: #0000DD; font-weight: bold } /* Literal.Number.Oct */ .highlight .sa { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Affix */ .highlight .sb { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Backtick */ .highlight .sc { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Char */ .highlight .dl { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Delimiter */ .highlight .sd { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Doc */ .highlight .s2 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Double */ .highlight .se { color: #0044dd; background-color: #fff0f0 } /* Literal.String.Escape */ .highlight .sh { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Heredoc */ .highlight .si { color: #3333bb; background-color: #fff0f0 } /* Literal.String.Interpol */ .highlight .sx { color: #22bb22; background-color: #f0fff0 } /* Literal.String.Other */ .highlight .sr { color: #008800; background-color: #fff0ff } /* Literal.String.Regex */ .highlight .s1 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Single */ .highlight .ss { color: #aa6600; background-color: #fff0f0 } /* Literal.String.Symbol */ .highlight .bp { color: #003388 } /* Name.Builtin.Pseudo */ .highlight .fm { color: #0066bb; font-weight: bold } /* Name.Function.Magic */ .highlight .vc { color: #336699 } /* Name.Variable.Class */ .highlight .vg { color: #dd7700 } /* Name.Variable.Global */ .highlight .vi { color: #3333bb } /* Name.Variable.Instance */ .highlight .vm { color: #336699 } /* Name.Variable.Magic */ .highlight .il { color: #0000DD; font-weight: bold } /* Literal.Number.Integer.Long */ }
###
# ============LICENSE_START=======================================================
# ECOMP MSO
# ================================================================================
# Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
# ================================================================================
# Licensed 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.
# ============LICENSE_END=========================================================
###

########################################################################
#Resource key=Error Code|Message text|Resolution text |Description text
#######
# {component}-{subcomponent}-{4-digit code}{classification}
#Newlines can be utilized to add some clarity ensuring continuing line
#has atleast one leading space
#ResourceKey=\
#             ERR0000E\
#             Sample error msg txt\
#             Sample resolution msg\
#             Sample description txt
#
#######
#Error code classification category
#1000-1099	Security/Permission Related
#2000-2099	Availability/Timeout Related
#3000-3099	Data Access/Integrity Related
#4000-4099	Schema Interface Type/Validation
#5000-5099	Business/Flow Processing Related
#6000-8099	Reserved \u2013 do not use
#9000-9099	Unknown Errors
#
######
#{classification} description
# I = Information
# W = Warning
# E = Error
# F = Fatal
########################################################################
APIH_QUERY_FOUND=\
				  MSO-APIH-3000I|\
                  Requests found when query DB with parameters {0}={1}|\
                  No resolution needed|\
                  Requests found when API Handler query DB
APIH_QUERY_NOT_FOUND=\
                  MSO-APIH-3001I|\
                  Request not found when query DB with parameters {0}={1}|\
                  No resolution needed|\
                  Request not found when API Handler query DB
APIH_DB_ACCESS_EXC=\
                  MSO-APIH-3003E|\
                  Unable to access DB|\
                  Please check other logs for more detailed info|\
                  Unable to access DB
APIH_DB_ACCESS_EXC_REASON=\
                  MSO-APIH-3005E|\
                  Unable to access DB: {0}|\
                  Please check other logs for more detailed info|\
                  Unable to access DB
APIH_DB_ATTRIBUTE_NOT_FOUND=\
                  MSO-APIH-3006E|\
                  Attribute {0} not found in DB|\
                  Please check other logs for more detailed info|\
                  Attribute not found in DB
APIH_DB_INSERT_EXC=\
                  MSO-APIH-3007E|\
                  Unable to insert record to DB|\
                  Please check other logs for more detailed info|\
                  Unable to insert record to DB
APIH_DB_UPDATE_EXC=\
                  MSO-APIH-3008E|\
                  Unable to update record to DB: {0}|\
                  Please check other logs for more detailed info|\
                  Unable to insert record to DB
APIH_VALIDATION_ERROR=\
                  MSO-APIH-4000E|\
                  Validation failed|\
                  Please check other logs for more detailed info|\
                  Validation failed
APIH_REQUEST_VALIDATION_ERROR=\
                  MSO-APIH-4001E|\
                  Validation of the input request failed, for incoming request:{0}|\
                  Please check other logs for more detailed info|\
                  Validation of the input request failed
APIH_SERVICE_VALIDATION_ERROR=\
                  MSO-APIH-4002E|\
                  Service params failed schema validation|\
                  Please check other logs for more detailed info|\
                  Service params failed schema validation
APIH_REQUEST_VALIDATION_ERROR_REASON=\
                  MSO-APIH-4003E|\
                  Validation of the input request failed:{0}|\
                  Please verify the input request|\
                  Validation of the input request failed
APIH_VNFREQUEST_VALIDATION_ERROR=\
                  MSO-APIH-4004E|\
                  Validation of the VNF Request failed|\
                  Please verify the VNF Request|\
                  Validation of the VNF Request failed
APIH_QUERY_PARAM_WRONG=\
                  MSO-APIH-5003W|\
                  Bad Request: {0}|\
                  Please verify the request|\
                  Bad Request
APIH_GENERAL_WARNING=\
                  MSO-APIH-5004W|\
                  WARNING: {0}|\
                  Please check other logs for more detailed info|\
                  General warning
APIH_AUDIT_EXEC=\
                  MSO-APIH-5005I|\
                  Executing request: {0}. {1}|\
                  No resolution needed|\
                  Executing method
APIH_GENERAL_METRICS=\
                  MSO-APIH-5008I|\
                  Executed method: {0}. {1}|\
                  No resolution needed|\
                  Generate information for Metric events
APIH_REQUEST_NULL=\
				          MSO-APIH-5009W|\
                  The request received by MSO is null|\
                  Please check other logs for more detailed info|\
                  The request received by MSO is null
APIH_DUPLICATE_FOUND=\
				          MSO-APIH-5011W|\
                  Duplicated request found: {0}|\
                  Please check other logs for more detailed info|\
                  Duplicated request found
APIH_BAD_ORDER=\
				          MSO-APIH-5012W|\
                  Request received with wrong order: {0}|\
                  Please check other logs for more detailed info|\
                  Request received with wrong order
APIH_BPEL_RESPONSE_ERROR=\
				          MSO-APIH-5014E|\
                  Abnormal response received from BPEL server: {0}|\
                  Please check other logs for more detailed info|\
                  Abnormal response received from BPEL server
APIH_WARP_REQUEST=\
				          MSO-APIH-5015E|\
                  Error wrapping request|\
                  Please check other logs for more detailed info|\
                  Error wrapping request to be sent to BPEL server
APIH_ERROR_FROM_BPEL_SERVER=\
				          MSO-APIH-5016E|\
                  Error from {0} with status:{1} and responseBody:{2}|\
                  Please check other logs for more detailed info|\
                  Error from BPEL Server
APIH_CANNOT_READ_SCHEMA=\
				          MSO-APIH-5017E|\
                  MSO Configuration Error - Unable to read the schema file|\
                  Please check other logs for more detailed info|\
                  MSO Configuration Error - Unable to read the schema file
APIH_PROPERTY_LOAD_SUC=\
				          MSO-APIH-5018I|\
                  Properties file loaded successfully|\
                  No resolution needed|\
                  Properties file loaded successfully
APIH_NO_PROPERTIES=\
				          MSO-APIH-5019E|\
                  Missing or invalid properties file: {0}|\
                  Please verify whether properties file exist or redable|\
                  Missing or invalid properties file
APIH_LOAD_PROPERTIES_FAIL=\
				          MSO-APIH-5020E|\
                  Unable to load properties file: {0}|\
                  Please verify whether properties file exist or redable|\
                  Unable to load properties file
APIH_GENERATED_REQUEST_ID=\
				          MSO-APIH-5021I|\
                  Missing requestID. Assigned {0}|\
                  No resolution needed|\
                  Request ID is not available
APIH_REPLACE_REQUEST_ID=\
				          MSO-APIH-5022I|\
                  Replaced invalid requestID of {0}|\
                  No resolution needed|\
                  Request ID received is not compliant with ECOMP Standards
APIH_GENERATED_SERVICE_INSTANCE_ID=\
				          MSO-APIH-5023I|\
                  Missing serviceInstanceID. Assigned {0}|\
                  No resolution needed|\
                  Service Instance ID is not available
APIH_GENERAL_EXCEPTION_ARG=\
                  MSO-APIH-9000E|\
                  Exception: {0}|\
                  Please check other logs for more detailed info|\
                  General exception with reason
APIH_GENERAL_EXCEPTION=\
                  MSO-APIH-9001E|\
                  Exception encountered|\
                  Please check other logs for more detailed info|\
                  Exception encountered
APIH_HEALTH_CHECK_EXCEPTION=\
                  MSO-APIH-9002E|\
                  Exception during health check|\
                  Please check other logs for more detailed info|\
                  Exception during health check
APIH_READ_VNFOUTPUT_CLOB_EXCEPTION=\
                  MSO-APIH-9003E|\
                  Exception reading vnfOutputs Clob|\
                  Please check other logs for more detailed info|\
                  Exception reading vnfOutputs Clob
APIH_DUPLICATE_CHECK_EXC=\
				          MSO-APIH-9004E|\
                  Exception during the duplication check for post services|\
                  Please check other logs for more detailed info|\
                  Exception during the duplicate check for post services
APIH_BPEL_COMMUNICATE_ERROR=\
				          MSO-APIH-9005E|\
                  Exception during BPEL POST|\
                  Please check other logs for more detailed info|\
                  Exception during BPEL POST
APIH_SDNC_COMMUNICATE_ERROR=\
				          MSO-APIH-9006E|\
                  Exception when sending HTTP POST request to SDNC Adapter|\
                  Please check other logs for more detailed info|\
                  Exception when sending HTTP POST request to SDNC Adapter
APIH_SDNC_RESPONSE_ERROR=\
				          MSO-APIH-9007E|\
                  IOException getting SDNC Adapter response body|\
                  Please check other logs for more detailed info|\
                  IOException getting SDNC Adapter response body
APIH_JAXB_MARSH_ERROR=\
				          MSO-APIH-9008E|\
                  Exception when translating query results into string with Jaxb|\
                  Please check other logs for more detailed info|\
                  Exception when translating query results into string with Jaxb
APIH_JAXB_UNMARSH_ERROR=\
				          MSO-APIH-9009E|\
                  Exception when formatting for VNF outputs with Jaxb|\
                  Please check other logs for more detailed info|\
                  Exception when formatting for VNF outputs
APIH_DOM2STR_ERROR=\
				          MSO-APIH-9010E|\
                  Error converting xml Document to String|\
                  Please check other logs for more detailed info|\
                  Error converting xml Document to String
APIH_DUPLICATE_CHECK_EXC_ATT=\
				          MSO-APIH-9011E|\
                  Exception during the duplication check for post services with the same attribute: {0}|\
                  Please check other logs for more detailed info|\
                  Exception during the duplicate check for post services