diff --git a/.gitignore b/.gitignore index 84adb3f..2061c9e 100644 --- a/.gitignore +++ b/.gitignore @@ -1,25 +1,3 @@ -# ---> Java -# Compiled class file -*.class - -# Log file -*.log - -# BlueJ files -*.ctxt - -# Mobile Tools for Java (J2ME) -.mtj.tmp/ - -# Package Files # -*.jar -*.war -*.nar -*.ear -*.zip -*.tar.gz -*.rar - -# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml -hs_err_pid* - +target +.classpath +.project diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..624770d --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,8 @@ +This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +# Changelog for Resource Registry Query Template Client + +## [v1.0.0-SNAPSHOT] + +- First Release + diff --git a/FUNDING.md b/FUNDING.md new file mode 100644 index 0000000..9e48b94 --- /dev/null +++ b/FUNDING.md @@ -0,0 +1,26 @@ +# Acknowledgments + +The projects leading to this software have received funding from a series of European Union programmes including: + +- the Sixth Framework Programme for Research and Technological Development + - [DILIGENT](https://cordis.europa.eu/project/id/004260) (grant no. 004260). +- the Seventh Framework Programme for research, technological development and demonstration + - [D4Science](https://cordis.europa.eu/project/id/212488) (grant no. 212488); + - [D4Science-II](https://cordis.europa.eu/project/id/239019) (grant no.239019); + - [ENVRI](https://cordis.europa.eu/project/id/283465) (grant no. 283465); + - [iMarine](https://cordis.europa.eu/project/id/283644) (grant no. 283644); + - [EUBrazilOpenBio](https://cordis.europa.eu/project/id/288754) (grant no. 288754). +- the H2020 research and innovation programme + - [SoBigData](https://cordis.europa.eu/project/id/654024) (grant no. 654024); + - [PARTHENOS](https://cordis.europa.eu/project/id/654119) (grant no. 654119); + - [EGI-Engage](https://cordis.europa.eu/project/id/654142) (grant no. 654142); + - [ENVRI PLUS](https://cordis.europa.eu/project/id/654182) (grant no. 654182); + - [BlueBRIDGE](https://cordis.europa.eu/project/id/675680) (grant no. 675680); + - [PerformFISH](https://cordis.europa.eu/project/id/727610) (grant no. 727610); + - [AGINFRA PLUS](https://cordis.europa.eu/project/id/731001) (grant no. 731001); + - [DESIRA](https://cordis.europa.eu/project/id/818194) (grant no. 818194); + - [ARIADNEplus](https://cordis.europa.eu/project/id/823914) (grant no. 823914); + - [RISIS 2](https://cordis.europa.eu/project/id/824091) (grant no. 824091); + - [EOSC-Pillar](https://cordis.europa.eu/project/id/857650) (grant no. 857650); + - [Blue Cloud](https://cordis.europa.eu/project/id/862409) (grant no. 862409); + - [SoBigData-PlusPlus](https://cordis.europa.eu/project/id/871042) (grant no. 871042); diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..3af0507 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,312 @@ +# European Union Public Licence V. 1.1 + + +EUPL © the European Community 2007 + + +This European Union Public Licence (the “EUPL”) applies to the Work or Software +(as defined below) which is provided under the terms of this Licence. Any use of +the Work, other than as authorised under this Licence is prohibited (to the +extent such use is covered by a right of the copyright holder of the Work). + +The Original Work is provided under the terms of this Licence when the Licensor +(as defined below) has placed the following notice immediately following the +copyright notice for the Original Work: + +Licensed under the EUPL V.1.1 + +or has expressed by any other mean his willingness to license under the EUPL. + + + +## 1. Definitions + +In this Licence, the following terms have the following meaning: + +- The Licence: this Licence. + +- The Original Work or the Software: the software distributed and/or + communicated by the Licensor under this Licence, available as Source Code and + also as Executable Code as the case may be. + +- Derivative Works: the works or software that could be created by the Licensee, + based upon the Original Work or modifications thereof. This Licence does not + define the extent of modification or dependence on the Original Work required + in order to classify a work as a Derivative Work; this extent is determined by + copyright law applicable in the country mentioned in Article 15. + +- The Work: the Original Work and/or its Derivative Works. + +- The Source Code: the human-readable form of the Work which is the most + convenient for people to study and modify. + +- The Executable Code: any code which has generally been compiled and which is + meant to be interpreted by a computer as a program. + +- The Licensor: the natural or legal person that distributes and/or communicates + the Work under the Licence. + +- Contributor(s): any natural or legal person who modifies the Work under the + Licence, or otherwise contributes to the creation of a Derivative Work. + +- The Licensee or “You”: any natural or legal person who makes any usage of the + Software under the terms of the Licence. + +- Distribution and/or Communication: any act of selling, giving, lending, + renting, distributing, communicating, transmitting, or otherwise making + available, on-line or off-line, copies of the Work or providing access to its + essential functionalities at the disposal of any other natural or legal + person. + + + +## 2. Scope of the rights granted by the Licence + +The Licensor hereby grants You a world-wide, royalty-free, non-exclusive, +sub-licensable licence to do the following, for the duration of copyright vested +in the Original Work: + +- use the Work in any circumstance and for all usage, reproduce the Work, modify +- the Original Work, and make Derivative Works based upon the Work, communicate +- to the public, including the right to make available or display the Work or +- copies thereof to the public and perform publicly, as the case may be, the +- Work, distribute the Work or copies thereof, lend and rent the Work or copies +- thereof, sub-license rights in the Work or copies thereof. + +Those rights can be exercised on any media, supports and formats, whether now +known or later invented, as far as the applicable law permits so. + +In the countries where moral rights apply, the Licensor waives his right to +exercise his moral right to the extent allowed by law in order to make effective +the licence of the economic rights here above listed. + +The Licensor grants to the Licensee royalty-free, non exclusive usage rights to +any patents held by the Licensor, to the extent necessary to make use of the +rights granted on the Work under this Licence. + + + +## 3. Communication of the Source Code + +The Licensor may provide the Work either in its Source Code form, or as +Executable Code. If the Work is provided as Executable Code, the Licensor +provides in addition a machine-readable copy of the Source Code of the Work +along with each copy of the Work that the Licensor distributes or indicates, in +a notice following the copyright notice attached to the Work, a repository where +the Source Code is easily and freely accessible for as long as the Licensor +continues to distribute and/or communicate the Work. + + + +## 4. Limitations on copyright + +Nothing in this Licence is intended to deprive the Licensee of the benefits from +any exception or limitation to the exclusive rights of the rights owners in the +Original Work or Software, of the exhaustion of those rights or of other +applicable limitations thereto. + + + +## 5. Obligations of the Licensee + +The grant of the rights mentioned above is subject to some restrictions and +obligations imposed on the Licensee. Those obligations are the following: + +Attribution right: the Licensee shall keep intact all copyright, patent or +trademarks notices and all notices that refer to the Licence and to the +disclaimer of warranties. The Licensee must include a copy of such notices and a +copy of the Licence with every copy of the Work he/she distributes and/or +communicates. The Licensee must cause any Derivative Work to carry prominent +notices stating that the Work has been modified and the date of modification. + +Copyleft clause: If the Licensee distributes and/or communicates copies of the +Original Works or Derivative Works based upon the Original Work, this +Distribution and/or Communication will be done under the terms of this Licence +or of a later version of this Licence unless the Original Work is expressly +distributed only under this version of the Licence. The Licensee (becoming +Licensor) cannot offer or impose any additional terms or conditions on the Work +or Derivative Work that alter or restrict the terms of the Licence. + +Compatibility clause: If the Licensee Distributes and/or Communicates Derivative +Works or copies thereof based upon both the Original Work and another work +licensed under a Compatible Licence, this Distribution and/or Communication can +be done under the terms of this Compatible Licence. For the sake of this clause, +“Compatible Licence” refers to the licences listed in the appendix attached to +this Licence. Should the Licensee’s obligations under the Compatible Licence +conflict with his/her obligations under this Licence, the obligations of the +Compatible Licence shall prevail. + +Provision of Source Code: When distributing and/or communicating copies of the +Work, the Licensee will provide a machine-readable copy of the Source Code or +indicate a repository where this Source will be easily and freely available for +as long as the Licensee continues to distribute and/or communicate the Work. + +Legal Protection: This Licence does not grant permission to use the trade names, +trademarks, service marks, or names of the Licensor, except as required for +reasonable and customary use in describing the origin of the Work and +reproducing the content of the copyright notice. + + + +## 6. Chain of Authorship + +The original Licensor warrants that the copyright in the Original Work granted +hereunder is owned by him/her or licensed to him/her and that he/she has the +power and authority to grant the Licence. + +Each Contributor warrants that the copyright in the modifications he/she brings +to the Work are owned by him/her or licensed to him/her and that he/she has the +power and authority to grant the Licence. + +Each time You accept the Licence, the original Licensor and subsequent +Contributors grant You a licence to their contributions to the Work, under the +terms of this Licence. + + + +## 7. Disclaimer of Warranty + +The Work is a work in progress, which is continuously improved by numerous +contributors. It is not a finished work and may therefore contain defects or +“bugs” inherent to this type of software development. + +For the above reason, the Work is provided under the Licence on an “as is” basis +and without warranties of any kind concerning the Work, including without +limitation merchantability, fitness for a particular purpose, absence of defects +or errors, accuracy, non-infringement of intellectual property rights other than +copyright as stated in Article 6 of this Licence. + +This disclaimer of warranty is an essential part of the Licence and a condition +for the grant of any rights to the Work. + + + +## 8. Disclaimer of Liability + +Except in the cases of wilful misconduct or damages directly caused to natural +persons, the Licensor will in no event be liable for any direct or indirect, +material or moral, damages of any kind, arising out of the Licence or of the use +of the Work, including without limitation, damages for loss of goodwill, work +stoppage, computer failure or malfunction, loss of data or any commercial +damage, even if the Licensor has been advised of the possibility of such +damage. However, the Licensor will be liable under statutory product liability +laws as far such laws apply to the Work. + + + +## 9. Additional agreements + +While distributing the Original Work or Derivative Works, You may choose to +conclude an additional agreement to offer, and charge a fee for, acceptance of +support, warranty, indemnity, or other liability obligations and/or services +consistent with this Licence. However, in accepting such obligations, You may +act only on your own behalf and on your sole responsibility, not on behalf of +the original Licensor or any other Contributor, and only if You agree to +indemnify, defend, and hold each Contributor harmless for any liability incurred +by, or claims asserted against such Contributor by the fact You have accepted +any such warranty or additional liability. + + + +## 10. Acceptance of the Licence + +The provisions of this Licence can be accepted by clicking on an icon “I agree” +placed under the bottom of a window displaying the text of this Licence or by +affirming consent in any other similar way, in accordance with the rules of +applicable law. Clicking on that icon indicates your clear and irrevocable +acceptance of this Licence and all of its terms and conditions. + +Similarly, you irrevocably accept this Licence and all of its terms and +conditions by exercising any rights granted to You by Article 2 of this Licence, +such as the use of the Work, the creation by You of a Derivative Work or the +Distribution and/or Communication by You of the Work or copies thereof. + + + +## 11. Information to the public + +In case of any Distribution and/or Communication of the Work by means of +electronic communication by You (for example, by offering to download the Work +from a remote location) the distribution channel or media (for example, a +website) must at least provide to the public the information requested by the +applicable law regarding the Licensor, the Licence and the way it may be +accessible, concluded, stored and reproduced by the Licensee. + + + +## 12. Termination of the Licence + +The Licence and the rights granted hereunder will terminate automatically upon +any breach by the Licensee of the terms of the Licence. + +Such a termination will not terminate the licences of any person who has +received the Work from the Licensee under the Licence, provided such persons +remain in full compliance with the Licence. + + + +## 13. Miscellaneous + +Without prejudice of Article 9 above, the Licence represents the complete +agreement between the Parties as to the Work licensed hereunder. + +If any provision of the Licence is invalid or unenforceable under applicable +law, this will not affect the validity or enforceability of the Licence as a +whole. Such provision will be construed and/or reformed so as necessary to make +it valid and enforceable. + +The European Commission may publish other linguistic versions and/or new +versions of this Licence, so far this is required and reasonable, without +reducing the scope of the rights granted by the Licence. New versions of the +Licence will be published with a unique version number. + +All linguistic versions of this Licence, approved by the European Commission, +have identical value. Parties can take advantage of the linguistic version of +their choice. + + + +## 14. Jurisdiction + +Any litigation resulting from the interpretation of this License, arising +between the European Commission, as a Licensor, and any Licensee, will be +subject to the jurisdiction of the Court of Justice of the European Communities, +as laid down in article 238 of the Treaty establishing the European Community. + +Any litigation arising between Parties, other than the European Commission, and +resulting from the interpretation of this License, will be subject to the +exclusive jurisdiction of the competent court where the Licensor resides or +conducts its primary business. + + + +## 15. Applicable Law + +This Licence shall be governed by the law of the European Union country where +the Licensor resides or has his registered office. + +This licence shall be governed by the Belgian law if: + +- a litigation arises between the European Commission, as a Licensor, and any +- Licensee; the Licensor, other than the European Commission, has no residence +- or registered office inside a European Union country. + + + +## Appendix + + + +“Compatible Licences” according to article 5 EUPL are: + + +- GNU General Public License (GNU GPL) v. 2 + +- Open Software License (OSL) v. 2.1, v. 3.0 + +- Common Public License v. 1.0 + +- Eclipse Public License v. 1.0 + +- Cecill v. 2.0 + diff --git a/README.md b/README.md index 4de2cc3..d0a78eb 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,48 @@ -# resource-registry-query-templates-client +# Resource Registry Query Template Client +Resource Registry Query Template Client is a library designed to interact with Resource Registry Query Template APIs + +## Built With + +* [OpenJDK](https://openjdk.java.net/) - The JDK used +* [Maven](https://maven.apache.org/) - Dependency Management + +## Documentation + +[Resource Registry Query Template Client](https://wiki.gcube-system.org/gcube/Resource_Registry_Service_-_Query_Templates_Management) + +## Change log + +See [Releases](https://code-repo.d4science.org/gCubeSystem/resource-registry-query-template-client/releases). + +## Authors + +* **Luca Frosini** ([ORCID](https://orcid.org/0000-0003-3183-2291)) - [ISTI-CNR Infrascience Group](http://nemis.isti.cnr.it/groups/infrascience) + +## How to Cite this Software + +Tell people how to cite this software. +* Cite an associated paper? +* Use a specific BibTeX entry for the software? + + @software{, + title = {gCube Resource Registry Query Template Client}, + author = {{Frosini, Luca}}, + organization = {ISTI - CNR}, + address = {Pisa, Italy}, + year = 2022, + url = {http://www.gcube-system.org/} + } + +## License + +This project is licensed under the EUPL V.1.1 License - see the [LICENSE.md](LICENSE.md) file for details. + + +## About the gCube Framework +This software is part of the [gCubeFramework](https://www.gcube-system.org/ "gCubeFramework"): an +open-source software toolkit used for building and operating Hybrid Data +Infrastructures enabling the dynamic deployment of Virtual Research Environments +by favouring the realisation of reuse oriented policies. + +The projects leading to this software have received funding from a series of European Union programmes see [FUNDING.md](FUNDING.md) diff --git a/pom.xml b/pom.xml new file mode 100644 index 0000000..0ce46ed --- /dev/null +++ b/pom.xml @@ -0,0 +1,76 @@ + + 4.0.0 + org.gcube.information-system + resource-registry-query-template-client + 1.0.0-SNAPSHOT + Resource Registry Query Template Client + Resource Registry Query Template Client is a library designed to interact with Resource Registry Query Template APIs + + + UTF-8 + InformationSystem + + + + scm:git:https://code-repo.d4science.org/gCubeSystem/${project.artifactId}.git + scm:git:https://code-repo.d4science.org/gCubeSystem/${project.artifactId}.git + https://code-repo.d4science.org/gCubeSystem/${project.artifactId} + + + + + + org.gcube.distribution + gcube-bom + 2.1.0-SNAPSHOT + pom + import + + + + + + + org.gcube.common + authorization-client + + + org.gcube.resources.discovery + ic-client + + + org.gcube.information-system + resource-registry-api + + + org.gcube.information-system + information-system-model + + + org.gcube.common + gxHTTP + + + org.slf4j + slf4j-api + + + + junit + junit + 4.11 + test + + + ch.qos.logback + logback-classic + test + + + org.gcube.resource-management + gcube-model + test + + + + \ No newline at end of file diff --git a/src/main/java/org/gcube/informationsystem/resourceregistry/queries/templates/ResourceRegistryQueryTemplateClient.java b/src/main/java/org/gcube/informationsystem/resourceregistry/queries/templates/ResourceRegistryQueryTemplateClient.java new file mode 100644 index 0000000..31dcac0 --- /dev/null +++ b/src/main/java/org/gcube/informationsystem/resourceregistry/queries/templates/ResourceRegistryQueryTemplateClient.java @@ -0,0 +1,35 @@ +package org.gcube.informationsystem.resourceregistry.queries.templates; + +import java.util.List; + +import org.gcube.informationsystem.queries.templates.reference.entities.QueryTemplate; +import org.gcube.informationsystem.resourceregistry.api.exceptions.ResourceRegistryException; +import org.gcube.informationsystem.resourceregistry.api.exceptions.queries.templates.QueryTemplateAlreadyPresentException; +import org.gcube.informationsystem.resourceregistry.api.exceptions.queries.templates.QueryTemplateNotFoundException; + +/** + * @author Luca Frosini (ISTI - CNR) + */ +public interface ResourceRegistryQueryTemplateClient { + + public QueryTemplate create(QueryTemplate queryTemplate) throws QueryTemplateAlreadyPresentException, ResourceRegistryException; + + public String create(String queryTemplate) throws QueryTemplateAlreadyPresentException, ResourceRegistryException; + + public QueryTemplate read(QueryTemplate queryTemplate) throws QueryTemplateNotFoundException, ResourceRegistryException; + + public QueryTemplate read(String queryTemplateName) throws QueryTemplateNotFoundException, ResourceRegistryException; + + public String readAsString(String queryTemplateName) throws QueryTemplateNotFoundException, ResourceRegistryException; + + public QueryTemplate update(QueryTemplate queryTemplate) throws QueryTemplateNotFoundException, ResourceRegistryException; + + public String update(String queryTemplate) throws QueryTemplateNotFoundException, ResourceRegistryException; + + public boolean delete(QueryTemplate queryTemplate) throws QueryTemplateNotFoundException, ResourceRegistryException; + + public boolean delete(String queryTemplateName) throws QueryTemplateNotFoundException, ResourceRegistryException; + + public List all() throws ResourceRegistryException; + +} diff --git a/src/main/java/org/gcube/informationsystem/resourceregistry/queries/templates/ResourceRegistryQueryTemplateClientFactory.java b/src/main/java/org/gcube/informationsystem/resourceregistry/queries/templates/ResourceRegistryQueryTemplateClientFactory.java new file mode 100644 index 0000000..dcb7130 --- /dev/null +++ b/src/main/java/org/gcube/informationsystem/resourceregistry/queries/templates/ResourceRegistryQueryTemplateClientFactory.java @@ -0,0 +1,121 @@ +package org.gcube.informationsystem.resourceregistry.queries.templates; + +import java.util.ArrayList; +import java.util.List; +import java.util.Random; + +import org.gcube.common.authorization.library.AuthorizationEntry; +import org.gcube.common.authorization.library.provider.SecurityTokenProvider; +import org.gcube.common.resources.gcore.GCoreEndpoint; +import org.gcube.common.resources.gcore.ServiceEndpoint; +import org.gcube.common.scope.api.ScopeProvider; +import org.gcube.informationsystem.resourceregistry.api.Constants; +import org.gcube.resources.discovery.client.queries.api.SimpleQuery; +import org.gcube.resources.discovery.icclient.ICFactory; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * @author Luca Frosini (ISTI - CNR) + */ +public class ResourceRegistryQueryTemplateClientFactory { + + private static final Logger logger = LoggerFactory.getLogger(ResourceRegistryQueryTemplateClientFactory.class); + + protected static List addresses; + + static { + addresses = new ArrayList<>(); + } + + private static String FORCED_URL = null; + + protected static void forceToURL(String url){ + FORCED_URL = url; + } + + private static String classFormat = "$resource/Profile/ServiceClass/text() eq '%1s'"; + private static String nameFormat = "$resource/Profile/ServiceName/text() eq '%1s'"; + private static String statusFormat = "$resource/Profile/DeploymentData/Status/text() eq 'ready'"; + private static String containsFormat = "$entry/@EntryName eq '%1s'"; + + + private static String serviceEndpointCategoryFormat = "$resource/Profile/Category/text() eq '%1s'"; + private static String serviceEndpointNameFormat = "$resource/Profile/Name/text() eq '%1s'"; + private static String serviceEndpointstatusFormat = "$resource/Profile/RunTime/Status/text() eq 'READY'"; + + public static String getCurrentContextFullName() { + String token = SecurityTokenProvider.instance.get(); + AuthorizationEntry authorizationEntry = null; + try { + authorizationEntry = org.gcube.common.authorization.client.Constants.authorizationService().get(token); + } catch(Exception e) { + return ScopeProvider.instance.get(); + } + return authorizationEntry.getContext(); + } + + private static SimpleQuery queryForService(){ + return ICFactory.queryFor(GCoreEndpoint.class) + .addCondition(String.format(classFormat, Constants.SERVICE_CLASS)) + .addCondition(String.format(nameFormat, Constants.SERVICE_NAME)) + .addCondition(String.format(statusFormat)) + .addVariable("$entry","$resource/Profile/AccessPoint/RunningInstanceInterfaces/Endpoint") + .addCondition(String.format(containsFormat, Constants.SERVICE_ENTRY_NAME)) + .setResult("$entry/text()"); + } + + private static SimpleQuery queryForProxy(){ + return ICFactory.queryFor(ServiceEndpoint.class) + .addCondition(String.format(serviceEndpointCategoryFormat, Constants.SERVICE_CLASS)) + .addCondition(String.format(serviceEndpointNameFormat, Constants.SERVICE_NAME)) + .addCondition(String.format(serviceEndpointstatusFormat)) + .addVariable("$entry","$resource/Profile/AccessPoint/Interface/Endpoint") + .addCondition(String.format(containsFormat, Constants.SERVICE_ENTRY_NAME)) + .setResult("$entry/text()"); + } + + + protected static List getAddresses(){ + List addresses = new ArrayList<>(); + + try { + SimpleQuery proxyQuery = queryForProxy(); + addresses = ICFactory.client().submit(proxyQuery); + if(addresses==null || addresses.isEmpty()){ + throw new Exception("No ResourceRegistry Proxy Found"); + } + } catch (Exception e) { + logger.debug("{}. Looking for RunningInstance.", e.getMessage()); + SimpleQuery serviceQuery = queryForService(); + addresses = ICFactory.client().submit(serviceQuery); + } + + return addresses; + } + + public static ResourceRegistryQueryTemplateClient create() { + String address = null; + + if(FORCED_URL!=null){ + address = FORCED_URL; + }else { + + if(addresses==null || addresses.isEmpty()) { + addresses = getAddresses(); + } + + if(addresses==null || addresses.isEmpty()){ + String error = String.format("No %s:%s found in the current context %s", Constants.SERVICE_CLASS, Constants.SERVICE_NAME, getCurrentContextFullName()); + throw new RuntimeException(error); + } + + Random random = new Random(); + int index = random.nextInt(addresses.size()); + address = addresses.get(index); + } + + return new ResourceRegistryQueryTemplateClientImpl(address); + } + +} diff --git a/src/main/java/org/gcube/informationsystem/resourceregistry/queries/templates/ResourceRegistryQueryTemplateClientImpl.java b/src/main/java/org/gcube/informationsystem/resourceregistry/queries/templates/ResourceRegistryQueryTemplateClientImpl.java new file mode 100644 index 0000000..7ca6195 --- /dev/null +++ b/src/main/java/org/gcube/informationsystem/resourceregistry/queries/templates/ResourceRegistryQueryTemplateClientImpl.java @@ -0,0 +1,206 @@ +package org.gcube.informationsystem.resourceregistry.queries.templates; + +import java.net.HttpURLConnection; +import java.util.List; + +import org.gcube.common.gxhttp.reference.GXConnection; +import org.gcube.common.gxhttp.request.GXHTTPStringRequest; +import org.gcube.informationsystem.queries.templates.reference.entities.QueryTemplate; +import org.gcube.informationsystem.resourceregistry.api.exceptions.ResourceRegistryException; +import org.gcube.informationsystem.resourceregistry.api.exceptions.queries.templates.QueryTemplateAlreadyPresentException; +import org.gcube.informationsystem.resourceregistry.api.exceptions.queries.templates.QueryTemplateNotFoundException; +import org.gcube.informationsystem.resourceregistry.api.rest.QueryTemplatePath; +import org.gcube.informationsystem.resourceregistry.api.rest.httputils.HTTPUtility; +import org.gcube.informationsystem.utils.ElementMapper; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * @author Luca Frosini (ISTI - CNR) + */ +public class ResourceRegistryQueryTemplateClientImpl implements ResourceRegistryQueryTemplateClient { + + private static final Logger logger = LoggerFactory.getLogger(ResourceRegistryQueryTemplateClientImpl.class); + + protected final String address; + + public ResourceRegistryQueryTemplateClientImpl(String address) { + this.address = address; + } + + @Override + public QueryTemplate create(QueryTemplate queryTemplate) throws QueryTemplateAlreadyPresentException, ResourceRegistryException { + try { + String queryTemplateString = ElementMapper.marshal(queryTemplate); + String res = create(queryTemplateString); + return ElementMapper.unmarshal(QueryTemplate.class, res); + } catch(ResourceRegistryException e) { + throw e; + } catch(Exception e) { + throw new RuntimeException(e); + } + } + + @Override + public String create(String queryTemplate) throws QueryTemplateAlreadyPresentException, ResourceRegistryException { + try { + logger.trace("Going to create: {}", queryTemplate); + QueryTemplate qt = ElementMapper.unmarshal(QueryTemplate.class, queryTemplate); + + GXHTTPStringRequest gxHTTPStringRequest = GXHTTPStringRequest.newRequest(address); + gxHTTPStringRequest.from(ResourceRegistryQueryTemplateClient.class.getSimpleName()); + gxHTTPStringRequest.header("Accept", GXConnection.APPLICATION_JSON_CHARSET_UTF_8); + gxHTTPStringRequest.header("Content-type", GXConnection.APPLICATION_JSON_CHARSET_UTF_8); + gxHTTPStringRequest.path(QueryTemplatePath.QUERY_TEMPLATES_PATH_PART); + gxHTTPStringRequest.path(qt.getName()); + + HttpURLConnection httpURLConnection = gxHTTPStringRequest.put(queryTemplate); + String c = HTTPUtility.getResponse(String.class, httpURLConnection); + + logger.trace("{} successfully created", c); + return c; + + } catch(ResourceRegistryException e) { + throw e; + } catch(Exception e) { + throw new RuntimeException(e); + } + } + + @Override + public QueryTemplate read(QueryTemplate queryTemplate) throws QueryTemplateNotFoundException, ResourceRegistryException { + return read(queryTemplate.getName()); + } + + @Override + public QueryTemplate read(String queryTemplateName) throws QueryTemplateNotFoundException, ResourceRegistryException { + try { + String queryTemplate = readAsString(queryTemplateName); + return ElementMapper.unmarshal(QueryTemplate.class, queryTemplate); + } catch(ResourceRegistryException e) { + throw e; + } catch(Exception e) { + throw new RuntimeException(e); + } + } + + @Override + public String readAsString(String queryTemplateName) throws QueryTemplateNotFoundException, ResourceRegistryException { + try { + logger.trace("Going to read {} with name {}", QueryTemplate.NAME, queryTemplateName); + GXHTTPStringRequest gxHTTPStringRequest = GXHTTPStringRequest.newRequest(address); + gxHTTPStringRequest.from(ResourceRegistryQueryTemplateClient.class.getSimpleName()); + gxHTTPStringRequest.header("Accept", GXConnection.APPLICATION_JSON_CHARSET_UTF_8); + gxHTTPStringRequest.path(QueryTemplatePath.QUERY_TEMPLATES_PATH_PART); + gxHTTPStringRequest.path(queryTemplateName); + + HttpURLConnection httpURLConnection = gxHTTPStringRequest.get(); + String c = HTTPUtility.getResponse(String.class, httpURLConnection); + + logger.debug("Got {} is {}", QueryTemplate.NAME, c); + return c; + } catch(ResourceRegistryException e) { + // logger.trace("Error Creating {}", facet, e); + throw e; + } catch(Exception e) { + // logger.trace("Error Creating {}", facet, e); + throw new RuntimeException(e); + } + } + + @Override + public QueryTemplate update(QueryTemplate queryTemplate) throws QueryTemplateNotFoundException, ResourceRegistryException { + try { + String queryTemplateString = ElementMapper.marshal(queryTemplate); + String res = update(queryTemplateString); + return ElementMapper.unmarshal(QueryTemplate.class, res); + } catch(ResourceRegistryException e) { + throw e; + } catch(Exception e) { + throw new RuntimeException(e); + } + } + + @Override + public String update(String queryTemplate) throws QueryTemplateNotFoundException, ResourceRegistryException { + try { + logger.trace("Going to update: {}", queryTemplate); + QueryTemplate qt = ElementMapper.unmarshal(QueryTemplate.class, queryTemplate); + + GXHTTPStringRequest gxHTTPStringRequest = GXHTTPStringRequest.newRequest(address); + gxHTTPStringRequest.from(ResourceRegistryQueryTemplateClient.class.getSimpleName()); + gxHTTPStringRequest.header("Accept", GXConnection.APPLICATION_JSON_CHARSET_UTF_8); + gxHTTPStringRequest.header("Content-type", GXConnection.APPLICATION_JSON_CHARSET_UTF_8); + gxHTTPStringRequest.path(QueryTemplatePath.QUERY_TEMPLATES_PATH_PART); + gxHTTPStringRequest.path(qt.getName()); + + HttpURLConnection httpURLConnection = gxHTTPStringRequest.put(queryTemplate); + String c = HTTPUtility.getResponse(String.class, httpURLConnection); + + logger.trace("{} successfully updated", c); + return c; + + } catch(ResourceRegistryException e) { + throw e; + } catch(Exception e) { + throw new RuntimeException(e); + } + } + + @Override + public boolean delete(QueryTemplate queryTemplate) throws QueryTemplateNotFoundException, ResourceRegistryException { + return delete(queryTemplate.getName()); + } + + @Override + public boolean delete(String queryTemplateName) throws QueryTemplateNotFoundException, ResourceRegistryException { + try { + logger.trace("Going to delete {} with name {}", QueryTemplate.NAME, queryTemplateName); + GXHTTPStringRequest gxHTTPStringRequest = GXHTTPStringRequest.newRequest(address); + gxHTTPStringRequest.from(ResourceRegistryQueryTemplateClient.class.getSimpleName()); + gxHTTPStringRequest.header("Accept", GXConnection.APPLICATION_JSON_CHARSET_UTF_8); + gxHTTPStringRequest.path(QueryTemplatePath.QUERY_TEMPLATES_PATH_PART); + gxHTTPStringRequest.path(queryTemplateName); + + HttpURLConnection httpURLConnection = gxHTTPStringRequest.delete(); + HTTPUtility.getResponse(String.class, httpURLConnection); + + boolean deleted = true; + + logger.info("{} with name {} {}", QueryTemplate.NAME, queryTemplateName, + deleted ? " successfully deleted" : "was NOT deleted"); + return deleted; + } catch(ResourceRegistryException e) { + // logger.trace("Error Creating {}", facet, e); + throw e; + } catch(Exception e) { + // logger.trace("Error Creating {}", facet, e); + throw new RuntimeException(e); + } + } + + @Override + public List all() throws ResourceRegistryException { + try { + logger.trace("Going to list {}s", QueryTemplate.NAME); + GXHTTPStringRequest gxHTTPStringRequest = GXHTTPStringRequest.newRequest(address); + gxHTTPStringRequest.from(ResourceRegistryQueryTemplateClient.class.getSimpleName()); + gxHTTPStringRequest.header("Accept", GXConnection.APPLICATION_JSON_CHARSET_UTF_8); + gxHTTPStringRequest.path(QueryTemplatePath.QUERY_TEMPLATES_PATH_PART); + + HttpURLConnection httpURLConnection = gxHTTPStringRequest.get(); + String all = HTTPUtility.getResponse(String.class, httpURLConnection); + + logger.debug("Got {}s are {}", QueryTemplate.NAME, all); + return ElementMapper.unmarshalList(QueryTemplate.class, all); + + } catch(ResourceRegistryException e) { + // logger.trace("Error Creating {}", facet, e); + throw e; + } catch(Exception e) { + // logger.trace("Error Creating {}", facet, e); + throw new RuntimeException(e); + } + } + +}