Issue #1705 Added support for registry object references

Change-Id: If489dcf41f02257ceb31bab1f5a917c3e6884252 Former-commit-id: 40f64feb63 [formerly 6fd5f4a8a8] [formerly 40f64feb63 [formerly 6fd5f4a8a8] [formerly df32d5e2e3 [formerly a1b3a525cafd0759dfed9a387f74649bb4a3a765]]] Former-commit-id: df32d5e2e3 Former-commit-id: c8930973da [formerly 79631f88f8] Former-commit-id: e001eb2e65
2013-09-18 10:58:27 -05:00 · 2013-09-18 10:58:27 -05:00 · 2600edea23
commit 2600edea23
parent 77a256f2ec
5 changed files with 182 additions and 1 deletions
--- a/edexOsgi/com.raytheon.uf.common.registry.ebxml/src/com/raytheon/uf/common/registry/constants/CanonicalQueryTypes.java
+++ b/edexOsgi/com.raytheon.uf.common.registry.ebxml/src/com/raytheon/uf/common/registry/constants/CanonicalQueryTypes.java
@ -30,6 +30,7 @@ package com.raytheon.uf.common.registry.constants;
 * Date         Ticket#     Engineer    Description
 * ------------ ----------  ----------- --------------------------
 * 4/9/2013     1802        bphillip    Initial implementation
+ * 9/18/2013    1705        bphillip    Added GetReferencedObject canonical query
 * </pre>
 * 
 * @author bphillip
@ -77,4 +78,6 @@ public class CanonicalQueryTypes {

    public static final String GET_NOTIFICATION = "urn:oasis:names:tc:ebxml-regrep:query:GetNotification";

+    public static final String GET_REFERENCED_OBJECT = "urn:oasis:names:tc:ebxml-regrep:query:GetReferencedObject";
+
 }
--- a/edexOsgi/com.raytheon.uf.edex.registry.ebxml/res/spring/ebxml-querytypes.xml
+++ b/edexOsgi/com.raytheon.uf.edex.registry.ebxml/res/spring/ebxml-querytypes.xml
@ -29,6 +29,7 @@
                <ref bean="getRegistryPackagesByMemberId" />
                <ref bean="keywordSearch" />
                <ref bean="registryPackageSelector" />
+                <ref bean="getReferencedObject"/>
            </util:list>
        </constructor-arg>
    </bean>
@ -125,6 +126,10 @@
        class="com.raytheon.uf.edex.registry.ebxml.services.query.types.canonical.RegistryPackageSelector">
        <property name="registryObjectDao" ref="registryObjectDao" />
    </bean>
-
+	<bean id="getReferencedObject"
+        class="com.raytheon.uf.edex.registry.ebxml.services.query.types.canonical.GetReferencedObject">
+        <property name="registryObjectDao" ref="registryObjectDao" />
+        <property name="referenceResolver" ref="objectReferenceResolver"/>
+    </bean>

 </beans>
--- a/edexOsgi/com.raytheon.uf.edex.registry.ebxml/src/com/raytheon/uf/edex/registry/ebxml/services/query/QueryConstants.java
+++ b/edexOsgi/com.raytheon.uf.edex.registry.ebxml/src/com/raytheon/uf/edex/registry/ebxml/services/query/QueryConstants.java
@ -29,6 +29,7 @@ package com.raytheon.uf.edex.registry.ebxml.services.query;
 * Date         Ticket#    Engineer    Description
 * ------------ ---------- ----------- --------------------------
 * Jan 18, 2012            bphillip     Initial creation
+ * 9/18/2013    1705       bphillip     Added objectReference
 * 
 * </pre>
 * 
@ -106,4 +107,6 @@ public class QueryConstants {
    public static final String QUERY_EXPRESSION = "queryExpression";

    public static final String QUERY_LANGUAGE = "queryLanguage";
+
+    public static final String OBJECT_REFERENCE = "objectReference";
 }
--- a/edexOsgi/com.raytheon.uf.edex.registry.ebxml/src/com/raytheon/uf/edex/registry/ebxml/services/query/types/canonical/GetReferencedObject.java
+++ b/edexOsgi/com.raytheon.uf.edex.registry.ebxml/src/com/raytheon/uf/edex/registry/ebxml/services/query/types/canonical/GetReferencedObject.java
@ -0,0 +1,154 @@
+/**
+ * This software was developed and / or modified by Raytheon Company,
+ * pursuant to Contract DG133W-05-CQ-1067 with the US Government.
+ * 
+ * U.S. EXPORT CONTROLLED TECHNICAL DATA
+ * This software product contains export-restricted data whose
+ * export/transfer/disclosure is restricted by U.S. law. Dissemination
+ * to non-U.S. persons whether in the United States or abroad requires
+ * an export license or other authorization.
+ * 
+ * Contractor Name:        Raytheon Company
+ * Contractor Address:     6825 Pine Street, Suite 340
+ *                         Mail Stop B8
+ *                         Omaha, NE 68106
+ *                         402.291.0100
+ * 
+ * See the AWIPS II Master Rights File ("Master Rights File.pdf") for
+ * further licensing information.
+ **/
+package com.raytheon.uf.edex.registry.ebxml.services.query.types.canonical;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import oasis.names.tc.ebxml.regrep.wsdl.registry.services.v4.MsgRegistryException;
+import oasis.names.tc.ebxml.regrep.wsdl.registry.services.v4.QueryManager;
+import oasis.names.tc.ebxml.regrep.xsd.query.v4.QueryRequest;
+import oasis.names.tc.ebxml.regrep.xsd.query.v4.QueryResponse;
+import oasis.names.tc.ebxml.regrep.xsd.query.v4.ResponseOptionType;
+import oasis.names.tc.ebxml.regrep.xsd.rim.v4.QueryType;
+import oasis.names.tc.ebxml.regrep.xsd.rim.v4.RegistryObjectType;
+import oasis.names.tc.ebxml.regrep.xsd.rim.v4.SlotType;
+import oasis.names.tc.ebxml.regrep.xsd.rim.v4.StringValueType;
+
+import com.raytheon.uf.common.registry.constants.CanonicalQueryTypes;
+import com.raytheon.uf.common.registry.constants.QueryReturnTypes;
+import com.raytheon.uf.common.registry.services.RegistrySOAPServices;
+import com.raytheon.uf.edex.registry.ebxml.exception.EbxmlRegistryException;
+import com.raytheon.uf.edex.registry.ebxml.services.lifecycle.ObjectReferenceResolver;
+import com.raytheon.uf.edex.registry.ebxml.services.query.QueryConstants;
+import com.raytheon.uf.edex.registry.ebxml.services.query.QueryParameters;
+import com.raytheon.uf.edex.registry.ebxml.services.query.types.CanonicalEbxmlQuery;
+
+/**
+ * 
+ * EBXML Canonical query to get a referenced object
+ * 
+ * <pre>
+ * 
+ * SOFTWARE HISTORY
+ * 
+ * Date         Ticket#     Engineer    Description
+ * ------------ ----------  ----------- --------------------------
+ * 9/18/2013    1705        bphillip    Initial implementation
+ * </pre>
+ * 
+ * @author bphillip
+ * @version 1
+ */
+public class GetReferencedObject extends CanonicalEbxmlQuery {
+
+    /** The list of valid parameters for this query */
+    private static final List<String> QUERY_PARAMETERS = new ArrayList<String>();
+
+    /** Object used to resolve object references */
+    private ObjectReferenceResolver referenceResolver;
+
+    /* Initializes the list of parameters */
+    static {
+        QUERY_PARAMETERS.add(QueryConstants.OBJECT_REFERENCE);
+    }
+
+    @Override
+    protected void query(QueryType queryType, QueryResponse queryResponse,
+            String client) throws EbxmlRegistryException {
+        RegistryObjectType referencedObject = null;
+        QueryParameters parameters = getParameterMap(queryType.getSlot(),
+                queryResponse);
+        if (parameters.containsParameter(QueryConstants.OBJECT_REFERENCE)) {
+
+            String refValue = (String) parameters.getParameter(
+                    QueryConstants.OBJECT_REFERENCE).get(0);
+            referencedObject = referenceResolver
+                    .getStaticReferencedObject(refValue);
+            if (referencedObject == null) {
+                try {
+                    referencedObject = referenceResolver
+                            .getDynamicReferencedObject(refValue);
+                } catch (MsgRegistryException e) {
+                    throw new EbxmlRegistryException("Error resolving object!",
+                            e);
+                }
+                if (referencedObject == null) {
+                    if (referenceResolver.isValidURL(refValue)) {
+                        String objectId = refValue.substring(refValue
+                                .lastIndexOf("/") + 1);
+                        String remoteAddress = refValue.replace(
+                                "/rest/registryObjects/" + objectId, "");
+                        QueryType queryObj = new QueryType();
+                        queryObj.setQueryDefinition(CanonicalQueryTypes.GET_REFERENCED_OBJECT);
+                        SlotType slot = new SlotType(
+                                QueryConstants.OBJECT_REFERENCE,
+                                new StringValueType(objectId));
+                        queryObj.getSlot().add(slot);
+                        QueryRequest query = new QueryRequest();
+                        query.setId("Resolve reference [" + refValue + "]");
+                        query.setQuery(queryObj);
+                        query.setResponseOption(new ResponseOptionType(
+                                QueryReturnTypes.REGISTRY_OBJECT, true));
+                        QueryManager remoteQueryManager = RegistrySOAPServices
+                                .getQueryServiceForHost(remoteAddress);
+                        try {
+                            QueryResponse remoteResponse = remoteQueryManager
+                                    .executeQuery(query);
+                            referencedObject = remoteResponse
+                                    .getRegistryObjects().get(0);
+                        } catch (MsgRegistryException e) {
+                            throw new EbxmlRegistryException(
+                                    "Error querying remote registry at ["
+                                            + remoteAddress
+                                            + "] to resolve reference to object "
+                                            + objectId, e);
+                        }
+                    } else {
+                        throw new EbxmlRegistryException(
+                                "Unable to resolve reference for value ["
+                                        + refValue + "]");
+                    }
+                }
+            }
+
+        } else {
+            statusHandler.info("Query did not specify object reference");
+        }
+        List<Object> values = new ArrayList<Object>();
+        values.add(referencedObject);
+        this.setResponsePayload(queryResponse, values);
+    }
+
+    @Override
+    protected List<String> getValidParameters() {
+        return QUERY_PARAMETERS;
+    }
+
+    @Override
+    public String getQueryDefinition() {
+        return CanonicalQueryTypes.GET_REFERENCED_OBJECT;
+    }
+
+    public void setReferenceResolver(ObjectReferenceResolver referenceResolver) {
+        this.referenceResolver = referenceResolver;
+    }
+
+}
--- a/edexOsgi/com.raytheon.uf.edex.registry.ebxml/utility/edex_static/base/ebxml/minDB/SubmitObjectsRequest_Queries.xml
+++ b/edexOsgi/com.raytheon.uf.edex.registry.ebxml/utility/edex_static/base/ebxml/minDB/SubmitObjectsRequest_Queries.xml
@ -706,5 +706,21 @@
                </rim:Description>
            </rim:Parameter>
        </rim:RegistryObject>    
+        <rim:RegistryObject xsi:type="rim:QueryDefinitionType" lid="urn:oasis:names:tc:ebxml-regrep:query:GetReferencedObject" id="urn:oasis:names:tc:ebxml-regrep:query:GetReferencedObject">
+            <rim:Name>
+                <rim:LocalizedString value="Get Referenced Object"/>
+            </rim:Name>
+            <rim:Description>
+                <rim:LocalizedString value="Gets Registry Object referenced"/>
+            </rim:Description>
+            <rim:Parameter parameterName="objectReference" dataType="string" minOccurs="0" maxOccurs="1">
+                <rim:Name>
+                    <rim:LocalizedString value="Object reference"/>
+                </rim:Name>
+                <rim:Description>
+                    <rim:LocalizedString value="ID of the object referenced"/>
+                </rim:Description>
+            </rim:Parameter>
+        </rim:RegistryObject> 
    </rim:RegistryObjectList>
 </SubmitObjectsRequest>