-#\r
-# Sonar, entreprise quality control tool.\r
-# Copyright (C) 2009 SonarSource SA\r
-# mailto:contact AT sonarsource DOT com\r
-#\r
-# Sonar is free software; you can redistribute it and/or\r
-# modify it under the terms of the GNU Lesser General Public\r
-# License as published by the Free Software Foundation; either\r
-# version 3 of the License, or (at your option) any later version.\r
-#\r
-# Sonar is distributed in the hope that it will be useful,\r
-# but WITHOUT ANY WARRANTY; without even the implied warranty of\r
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\r
-# Lesser General Public License for more details.\r
-#\r
-# You should have received a copy of the GNU Lesser General Public\r
-# License along with Sonar; if not, write to the Free Software\r
-# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02\r
-#\r
-\r
-require "json"\r
-\r
-class Api::PropertiesController < Api::RestController\r
-\r
- before_filter :admin_required, :only => [ :create, :update, :destroy ]\r
-\r
- def index\r
- properties = Property.find(:all, :conditions => ['resource_id is null and user_id is null']).select do |property|\r
- viewable?(property.key)\r
- end\r
- rest_render(properties)\r
- end\r
-\r
- def show\r
- key = params[:id]\r
- prop = Property.by_key(key)\r
- if prop\r
- if viewable?(key)\r
- rest_render([prop])\r
- else\r
- rest_status_ko('You are not authorized to see this ressource', 401)\r
- end\r
- else\r
- rest_status_ko('Property [' + params[:id] + '] does not exist', 404)\r
- end\r
- end\r
-\r
- def create\r
- key = params[:id]\r
- value = params[:value]\r
- if key\r
- begin\r
- Property.set(key, value)\r
- rest_status_ok\r
- rescue Exception => ex\r
- rest_status_ko(ex.message, 400)\r
- end\r
- else\r
- rest_status_ko('Property key [' + params[:id] + '] is not valid', 400)\r
- end\r
- end\r
-\r
- def update\r
- key = params[:id]\r
- value = params[:value]\r
- if key\r
- begin\r
- Property.set(key, value)\r
- rest_status_ok\r
- rescue Exception => ex\r
- rest_status_ko(ex.message, 400)\r
- end\r
- else\r
- rest_status_ko('Property key [' + params[:id] + '] is not valid', 400)\r
- end\r
- end\r
-\r
- def destroy\r
- key = params[:id]\r
- if key \r
- begin\r
- Property.clear(key)\r
- rest_status_ok\r
- rescue Exception => ex\r
- rest_status_ko(ex.message, 400)\r
- end\r
- else\r
- rest_status_ko('Property key [' + params[:id] + '] is not valid', 400)\r
- end\r
- end\r
-\r
- protected\r
-\r
- def rest_to_json(properties)\r
- JSON(properties.collect{|property| property.to_hash_json})\r
- end\r
-\r
- def rest_to_xml(properties)\r
- xml = Builder::XmlMarkup.new(:indent => 0)\r
- xml.instruct!\r
- xml.properties do\r
- properties.each do |property|\r
- property.to_xml(xml)\r
- end\r
- end\r
- end\r
-\r
- private\r
-\r
- def viewable?(property_key)\r
- !property_key.to_s.index('.secured') || is_admin?\r
- end\r
-\r
+#
+# Sonar, entreprise quality control tool.
+# Copyright (C) 2009 SonarSource SA
+# mailto:contact AT sonarsource DOT com
+#
+# Sonar is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 3 of the License, or (at your option) any later version.
+#
+# Sonar is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with Sonar; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02
+#
+
+require "json"
+
+class Api::PropertiesController < Api::RestController
+
+ before_filter :admin_required, :only => [ :create, :update, :destroy ]
+
+ def index
+ properties = Property.find(:all, :conditions => ['resource_id is null and user_id is null']).select do |property|
+ viewable?(property.key)
+ end
+ rest_render(properties)
+ end
+
+ def show
+ key = params[:id]
+ prop = Property.by_key(key)
+ if prop
+ if viewable?(key)
+ rest_render([prop])
+ else
+ rest_status_ko('You are not authorized to see this ressource', 401)
+ end
+ else
+ rest_status_ko('Property [' + params[:id] + '] does not exist', 404)
+ end
+ end
+
+ def create
+ key = params[:id]
+ value = params[:value] || request.raw_post
+ if key
+ begin
+ Property.set(key, value)
+ rest_status_ok
+ rescue Exception => ex
+ rest_status_ko(ex.message, 400)
+ end
+ else
+ rest_status_ko('Property key [' + params[:id] + '] is not valid', 400)
+ end
+ end
+
+ def update
+ key = params[:id]
+ value = params[:value] || request.raw_post
+ if key
+ begin
+ Property.set(key, value)
+ rest_status_ok
+ rescue Exception => ex
+ rest_status_ko(ex.message, 400)
+ end
+ else
+ rest_status_ko('Property key [' + params[:id] + '] is not valid', 400)
+ end
+ end
+
+ def destroy
+ key = params[:id]
+ if key
+ begin
+ Property.clear(key)
+ rest_status_ok
+ rescue Exception => ex
+ rest_status_ko(ex.message, 400)
+ end
+ else
+ rest_status_ko('Property key [' + params[:id] + '] is not valid', 400)
+ end
+ end
+
+ protected
+
+ def rest_to_json(properties)
+ JSON(properties.collect{|property| property.to_hash_json})
+ end
+
+ def rest_to_xml(properties)
+ xml = Builder::XmlMarkup.new(:indent => 0)
+ xml.instruct!
+ xml.properties do
+ properties.each do |property|
+ property.to_xml(xml)
+ end
+ end
+ end
+
+ private
+
+ def viewable?(property_key)
+ !property_key.to_s.index('.secured') || is_admin?
+ end
+
end
\ No newline at end of file
return result;
}
+ public void update(UpdateQuery<?> query) {
+ connector.execute(query);
+ }
+
public void delete(DeleteQuery<?> query) {
connector.execute(query);
}
import org.sonar.wsclient.services.CreateQuery;
import org.sonar.wsclient.services.DeleteQuery;
import org.sonar.wsclient.services.Query;
+import org.sonar.wsclient.services.UpdateQuery;
/**
* @since 2.1
*/
public abstract String execute(DeleteQuery<?> query);
+ /**
+ * @return JSON response or null if 404 NOT FOUND error
+ * @since 2.6
+ */
+ public abstract String execute(UpdateQuery<?> query);
}
import org.apache.commons.httpclient.methods.DeleteMethod;
import org.apache.commons.httpclient.methods.GetMethod;
import org.apache.commons.httpclient.methods.PostMethod;
+import org.apache.commons.httpclient.methods.PutMethod;
+import org.apache.commons.httpclient.methods.StringRequestEntity;
import org.apache.commons.httpclient.params.HttpConnectionManagerParams;
import org.apache.commons.httpclient.util.URIUtil;
import org.sonar.wsclient.Host;
import org.sonar.wsclient.services.CreateQuery;
import org.sonar.wsclient.services.DeleteQuery;
import org.sonar.wsclient.services.Query;
+import org.sonar.wsclient.services.UpdateQuery;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
+import java.io.UnsupportedEncodingException;
/**
* @since 2.1
return executeRequest(newPostRequest(query));
}
+ public String execute(UpdateQuery<?> query) {
+ return executeRequest(newPutRequest(query));
+ }
+
public String execute(DeleteQuery<?> query) {
return executeRequest(newDeleteRequest(query));
}
private HttpMethodBase newPostRequest(CreateQuery<?> query) {
try {
String url = server.getHost() + URIUtil.encodeQuery(query.getUrl());
- HttpMethodBase method = new PostMethod(url);
+ PostMethod method = new PostMethod(url);
+ method.setRequestHeader("Accept", "application/json");
+ if (query.getBody() != null) {
+ method.setRequestEntity(new StringRequestEntity(query.getBody(), "text/plain; charset=UTF-8", "UTF-8"));
+ }
+ return method;
+
+ } catch (URIException e) {
+ throw new ConnectionException("Query: " + query, e);
+ } catch (UnsupportedEncodingException e) {
+ throw new ConnectionException("Unsupported encoding", e);
+ }
+ }
+
+ private HttpMethodBase newPutRequest(UpdateQuery<?> query) {
+ try {
+ String url = server.getHost() + URIUtil.encodeQuery(query.getUrl());
+ PutMethod method = new PutMethod(url);
method.setRequestHeader("Accept", "application/json");
+ if (query.getBody() != null) {
+ method.setRequestEntity(new StringRequestEntity(query.getBody(), "text/plain; charset=UTF-8", "UTF-8"));
+ }
return method;
} catch (URIException e) {
throw new ConnectionException("Query: " + query, e);
+ } catch (UnsupportedEncodingException e) {
+ throw new ConnectionException("Unsupported encoding", e);
}
}
import org.apache.http.client.methods.HttpDelete;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.methods.HttpPost;
+import org.apache.http.client.methods.HttpPut;
import org.apache.http.client.methods.HttpRequestBase;
import org.apache.http.client.protocol.ClientContext;
+import org.apache.http.entity.StringEntity;
import org.apache.http.impl.auth.BasicScheme;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.params.HttpConnectionParams;
import org.sonar.wsclient.services.CreateQuery;
import org.sonar.wsclient.services.DeleteQuery;
import org.sonar.wsclient.services.Query;
+import org.sonar.wsclient.services.UpdateQuery;
import java.io.IOException;
+import java.io.UnsupportedEncodingException;
/**
* @since 2.1
return executeRequest(newPostMethod(query));
}
+ public String execute(UpdateQuery<?> query) {
+ return executeRequest(newPutMethod(query));
+ }
+
public String execute(DeleteQuery<?> query) {
return executeRequest(newDeleteMethod(query));
}
private HttpPost newPostMethod(CreateQuery<?> query) {
HttpPost post = new HttpPost(server.getHost() + query.getUrl());
+ if (query.getBody() != null) {
+ try {
+ post.setEntity(new StringEntity(query.getBody(), "UTF-8"));
+ } catch (UnsupportedEncodingException e) {
+ throw new ConnectionException("Encoding is not supported", e);
+ }
+ }
setJsonHeader(post);
return post;
}
+ private HttpPut newPutMethod(UpdateQuery<?> query) {
+ HttpPut put = new HttpPut(server.getHost() + query.getUrl());
+ if (query.getBody() != null) {
+ try {
+ put.setEntity(new StringEntity(query.getBody(), "UTF-8"));
+ } catch (UnsupportedEncodingException e) {
+ throw new ConnectionException("Encoding is not supported", e);
+ }
+ }
+ setJsonHeader(put);
+ return put;
+ }
+
private void setJsonHeader(HttpRequestBase request) {
request.setHeader("Accept", "application/json");
}
*/
public abstract String getUrl();
+ /**
+ * Request body. By defaut it is empty but it can be overriden.
+ */
+ public String getBody() {
+ return null;
+ }
+
protected static void appendUrlParameter(StringBuilder url, String paramKey, Object paramValue) {
if (paramValue != null) {
url.append(paramKey)
--- /dev/null
+/*
+ * Sonar, open source software quality management tool.
+ * Copyright (C) 2009 SonarSource SA
+ * mailto:contact AT sonarsource DOT com
+ *
+ * Sonar is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * Sonar is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with Sonar; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02
+ */
+package org.sonar.wsclient.services;
+
+/**
+ * PUT HTTP request
+ *
+ * @since 2.6
+ */
+public abstract class UpdateQuery<MODEL extends Model> extends AbstractQuery<MODEL> {
+
+ public abstract Class<MODEL> getModelClass();
+
+}
projects / sonarqube.git / commitdiff