org.eclipse.lyo.client.oslc.resources.OslcQuery Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of oslc-java-client Show documentation
Eclipse Lyo OSLC Java client based on OSLC4J and Apache Wink.
There is a newer version: 5.0.0.alpha1
/*
 * Copyright (c) 2020 Contributors to the Eclipse Foundation
 *
 * See the NOTICE file(s) distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0, or the Eclipse Distribution License 1.0
 * which is available at http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause
 */
package org.eclipse.lyo.client.oslc.resources;


import org.apache.wink.client.ClientResponse;
import org.apache.wink.client.Resource;
import org.eclipse.lyo.client.oslc.OSLCConstants;
import org.eclipse.lyo.client.oslc.OslcClient;
import org.eclipse.lyo.client.oslc.OslcOAuthClient;

/**
 * Represents an OSLC query (HTTP GET) request to be made of a remote system.
 *
 * Immutable.
 */
@Deprecated
public class OslcQuery {

	private final OslcClient oslcClient;

	private final String capabilityUrl;

	private String queryUrl;

	private final int pageSize;

	private final Resource queryResource;

	//query parameters
	private final String where;
	private final String select;
	private final String orderBy;
	private final String searchTerms;
	private final String prefix;


	/**
	 * Create an OSLC query that uses the remote system's default page size.
	 *
	 * @param oslcClient the authenticated OSLC client
	 * @param capabilityUrl the URL that is the base
	 */
	public OslcQuery(OslcClient oslcClient, String capabilityUrl) {
		this(oslcClient, capabilityUrl, 0);
	}

	/**
	 * Create an OSLC query with query parameters that uses the default page size
	 * @param oslcClient the authenticated OSLC client
	 * @param capabilityUrl capabilityUrl the URL that is the base
	 * @param oslcQueryParams an OslcQueryParameters object
	 * @see OslcQueryParameters
	 */
	public OslcQuery(OslcClient oslcClient, String capabilityUrl, OslcQueryParameters oslcQueryParams) {
		this(oslcClient, capabilityUrl, 0, oslcQueryParams);
	}

	/**
	 * Create an OSLC query that uses the given page size
	 *
	 * @param oslcClient the authenticated OSLC client
	 * @param capabilityUrl the URL that is the base
	 * @param pageSize the number of results to include on each page (OslcQueryResult)
	 *
	 */
	public OslcQuery(OslcClient oslcClient, String capabilityUrl, int pageSize) {
		this(oslcClient, capabilityUrl, pageSize, null);
	}

	/**
	 * Create an OSLC query that uses OSLC query parameters and the given page size
	 *
	 * @param oslcClient the authenticated OSLC client
	 * @param capabilityUrl the URL that is the base
	 * @param pageSize the number of results to include on each page (OslcQueryResult)
	 * @param oslcQueryParams an OslcQueryParameters object
	 * @see OslcQueryParameters
	 */
	public OslcQuery(OslcClient oslcClient, String capabilityUrl,
					 int pageSize, OslcQueryParameters oslcQueryParams) {
		this.oslcClient = oslcClient;
		this.capabilityUrl = capabilityUrl;
		this.pageSize = (pageSize < 1) ? 0 : pageSize;

		//make a local copy of any query parameters
		if (oslcQueryParams != null)
		{
			this.where = oslcQueryParams.getWhere();
			this.select = oslcQueryParams.getSelect();
			this.orderBy = oslcQueryParams.getOrderBy();
			this.searchTerms = oslcQueryParams.getSearchTerms();
			this.prefix = oslcQueryParams.getPrefix();
		} else {
			this.where = this.select = this.orderBy = this.searchTerms = this.prefix = null;
		}
		this.queryResource = createQueryResource();
		this.queryUrl = this.getQueryUrl();

	}

	OslcQuery(OslcQueryResult previousResult) {
		this(previousResult.getQuery(), previousResult.getNextPageUrl());
	}

	private OslcQuery(OslcQuery previousQuery, String nextPageUrl) {
		this(previousQuery.oslcClient, previousQuery.capabilityUrl, previousQuery.pageSize);
		this.queryUrl = nextPageUrl;
		this.queryResource.uri(nextPageUrl);
	}

	private Resource createQueryResource() {
		Resource resource = oslcClient.getQueryResource(this);
		resource.accept(OSLCConstants.CT_RDF);
		resource.header(OSLCConstants.OSLC_CORE_VERSION,"2.0");
		applyPagination(resource);
		applyOslcQueryParams(resource);
		return resource;
	}

	private void applyPagination(Resource resource) {
		if (pageSize > 0) {
			resource.queryParam("oslc.paging", "true");
			resource.queryParam("oslc.pageSize", pageSize);
		}
	}

	private void applyOslcQueryParams(Resource resource) {
		if (this.where != null && !this.where.isEmpty()) {
			resource.queryParam("oslc.where", this.where);
		}
		if (this.select != null && !this.select.isEmpty()) {
			resource.queryParam("oslc.select", this.select);
		}
		if (this.orderBy != null && !this.orderBy.isEmpty()) {
			resource.queryParam("oslc.orderBy", this.orderBy);
		}
		if (this.searchTerms != null && !this.searchTerms.isEmpty()) {
			resource.queryParam("oslc.searchTerms", this.searchTerms);
		}
		if (this.prefix != null && !this.prefix.isEmpty()) {
			resource.queryParam("oslc.prefix", this.prefix);
		}
	}

	/**
	 * @return the number of entries to return for each page,
	 * 		if zero, the remote system's (or full query's) default is used
	 */
	public int getPageSize() {
		return pageSize;
	}

	/**
	 * @return the base query capability URL
	 */
	public String getCapabilityUrl() {
		return capabilityUrl;
	}

	/**
	 * @return the complete query URL
	 */
	public String getQueryUrl() {
		if (queryUrl == null) {
			queryUrl = queryResource.getUriBuilder().build(new Object[0]).toString();
		}
		return queryUrl;
	}

	public OslcQueryResult submit() {
		return new OslcQueryResult(this, getResponse());
	}

	ClientResponse getResponse() {

		ClientResponse cr = null;
		// If using an OAuth client, redirect the call
		if ( oslcClient instanceof OslcOAuthClient ){
			try {
				cr = oslcClient.getResource(getQueryUrl(), OSLCConstants.CT_RDF);
			} catch (Exception e) {
				// Log error or raise exception
			}
		} else {
			cr = queryResource.get();
		}

		return cr;
	}

}