From f554dc2aa0478aa23f7e986b6779091f7d520bf5 Mon Sep 17 00:00:00 2001 From: Endi Sukma Dewata Date: Sat, 11 Aug 2012 08:37:52 -0500 Subject: Cleaned up REST common class names. The REST common classes have been renamed for better clarity and consistency. Ticket #259 --- .../cms/servlet/base/BadRequestException.java | 2 +- .../netscape/cms/servlet/base/CMSException.java | 182 --------------------- .../netscape/cms/servlet/base/PKIException.java | 182 +++++++++++++++++++++ .../com/netscape/cms/servlet/base/PKIService.java | 6 +- .../cms/servlet/base/UnauthorizedException.java | 2 +- 5 files changed, 187 insertions(+), 187 deletions(-) delete mode 100644 base/common/src/com/netscape/cms/servlet/base/CMSException.java create mode 100644 base/common/src/com/netscape/cms/servlet/base/PKIException.java (limited to 'base/common/src/com/netscape/cms/servlet/base') diff --git a/base/common/src/com/netscape/cms/servlet/base/BadRequestException.java b/base/common/src/com/netscape/cms/servlet/base/BadRequestException.java index b5c5e0b12..cefa26985 100644 --- a/base/common/src/com/netscape/cms/servlet/base/BadRequestException.java +++ b/base/common/src/com/netscape/cms/servlet/base/BadRequestException.java @@ -18,7 +18,7 @@ package com.netscape.cms.servlet.base; import javax.ws.rs.core.Response; -public class BadRequestException extends CMSException { +public class BadRequestException extends PKIException { private static final long serialVersionUID = -4784839378360933483L; diff --git a/base/common/src/com/netscape/cms/servlet/base/CMSException.java b/base/common/src/com/netscape/cms/servlet/base/CMSException.java deleted file mode 100644 index 5ceb30ee1..000000000 --- a/base/common/src/com/netscape/cms/servlet/base/CMSException.java +++ /dev/null @@ -1,182 +0,0 @@ -// --- BEGIN COPYRIGHT BLOCK --- -// This program is free software; you can redistribute it and/or modify -// it under the terms of the GNU General Public License as published by -// the Free Software Foundation; version 2 of the License. -// -// This program 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 General Public License for more details. -// -// You should have received a copy of the GNU General Public License along -// with this program; if not, write to the Free Software Foundation, Inc., -// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. -// -// (C) 2007 Red Hat, Inc. -// All rights reserved. -// --- END COPYRIGHT BLOCK --- -package com.netscape.cms.servlet.base; - -import java.util.ArrayList; -import java.util.LinkedHashMap; -import java.util.List; -import java.util.Map; - -import javax.ws.rs.core.MediaType; -import javax.ws.rs.core.Response; -import javax.ws.rs.ext.ExceptionMapper; -import javax.ws.rs.ext.Provider; -import javax.xml.bind.JAXBContext; -import javax.xml.bind.Marshaller; -import javax.xml.bind.annotation.XmlAttribute; -import javax.xml.bind.annotation.XmlElement; -import javax.xml.bind.annotation.XmlRootElement; -import javax.xml.bind.annotation.XmlValue; -import javax.xml.bind.annotation.adapters.XmlAdapter; -import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter; - -public class CMSException extends RuntimeException { - - private static final long serialVersionUID = 6000910362260369923L; - - public int code; - - public CMSException(String message) { - super(message); - code = Response.Status.INTERNAL_SERVER_ERROR.getStatusCode(); - } - - public CMSException(int code, String message) { - super(message); - this.code = code; - } - - public CMSException(Response.Status status, String message) { - super(message); - code = status.getStatusCode(); - } - - public CMSException(String message, Throwable cause) { - super(message, cause); - code = Response.Status.INTERNAL_SERVER_ERROR.getStatusCode(); - } - - public CMSException(int code, String message, Throwable cause) { - super(message, cause); - this.code = code; - } - - public CMSException(Response.Status status, String message, Throwable cause) { - super(message, cause); - code = status.getStatusCode(); - } - - public CMSException(Data data) { - super(data.message); - code = data.code; - } - - public int getCode() { - return code; - } - - public void setCode(int code) { - this.code = code; - } - - public Data getData() { - Data data = new Data(); - data.className = getClass().getName(); - data.code = code; - data.message = getMessage(); - return data; - } - - @XmlRootElement(name="CMSException") - public static class Data { - - @XmlElement(name="ClassName") - public String className; - - @XmlElement(name="Code") - public int code; - - @XmlElement(name="Message") - public String message; - - @XmlElement(name="Attributes") - @XmlJavaTypeAdapter(MapAdapter.class) - public Map attributes = new LinkedHashMap(); - - public String getAttribute(String name) { - return attributes.get(name); - } - - public void setAttribute(String name, String value) { - attributes.put(name, value); - } - } - - public static class MapAdapter extends XmlAdapter> { - - public AttributeList marshal(Map map) { - AttributeList list = new AttributeList(); - for (Map.Entry entry : map.entrySet()) { - Attribute attribute = new Attribute(); - attribute.name = entry.getKey(); - attribute.value = entry.getValue(); - list.attributes.add(attribute); - } - return list; - } - - public Map unmarshal(AttributeList list) { - Map map = new LinkedHashMap(); - for (Attribute attribute : list.attributes) { - map.put(attribute.name, attribute.value); - } - return map; - } - } - - public static class AttributeList { - @XmlElement(name="Attribute") - public List attributes = new ArrayList(); - } - - public static class Attribute { - - @XmlAttribute - public String name; - - @XmlValue - public String value; - } - - @Provider - public static class Mapper implements ExceptionMapper { - - public Response toResponse(CMSException exception) { - // convert CMSException into HTTP response with XML content - return Response - .status(exception.getCode()) - .entity(exception.getData()) - .type(MediaType.APPLICATION_XML) - .build(); - } - } - - public static void main(String args[]) throws Exception { - Data data = new Data(); - data.className = CMSException.class.getName(); - data.code = Response.Status.INTERNAL_SERVER_ERROR.getStatusCode(); - data.message = "An error has occured"; - data.setAttribute("attr1", "value1"); - data.setAttribute("attr2", "value2"); - - JAXBContext context = JAXBContext.newInstance(Data.class); - Marshaller marshaller = context.createMarshaller(); - marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true); - marshaller.marshal(data, System.out); - } -} diff --git a/base/common/src/com/netscape/cms/servlet/base/PKIException.java b/base/common/src/com/netscape/cms/servlet/base/PKIException.java new file mode 100644 index 000000000..be2629e17 --- /dev/null +++ b/base/common/src/com/netscape/cms/servlet/base/PKIException.java @@ -0,0 +1,182 @@ +// --- BEGIN COPYRIGHT BLOCK --- +// This program is free software; you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation; version 2 of the License. +// +// This program 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 General Public License for more details. +// +// You should have received a copy of the GNU General Public License along +// with this program; if not, write to the Free Software Foundation, Inc., +// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. +// +// (C) 2007 Red Hat, Inc. +// All rights reserved. +// --- END COPYRIGHT BLOCK --- +package com.netscape.cms.servlet.base; + +import java.util.ArrayList; +import java.util.LinkedHashMap; +import java.util.List; +import java.util.Map; + +import javax.ws.rs.core.MediaType; +import javax.ws.rs.core.Response; +import javax.ws.rs.ext.ExceptionMapper; +import javax.ws.rs.ext.Provider; +import javax.xml.bind.JAXBContext; +import javax.xml.bind.Marshaller; +import javax.xml.bind.annotation.XmlAttribute; +import javax.xml.bind.annotation.XmlElement; +import javax.xml.bind.annotation.XmlRootElement; +import javax.xml.bind.annotation.XmlValue; +import javax.xml.bind.annotation.adapters.XmlAdapter; +import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter; + +public class PKIException extends RuntimeException { + + private static final long serialVersionUID = 6000910362260369923L; + + public int code; + + public PKIException(String message) { + super(message); + code = Response.Status.INTERNAL_SERVER_ERROR.getStatusCode(); + } + + public PKIException(int code, String message) { + super(message); + this.code = code; + } + + public PKIException(Response.Status status, String message) { + super(message); + code = status.getStatusCode(); + } + + public PKIException(String message, Throwable cause) { + super(message, cause); + code = Response.Status.INTERNAL_SERVER_ERROR.getStatusCode(); + } + + public PKIException(int code, String message, Throwable cause) { + super(message, cause); + this.code = code; + } + + public PKIException(Response.Status status, String message, Throwable cause) { + super(message, cause); + code = status.getStatusCode(); + } + + public PKIException(Data data) { + super(data.message); + code = data.code; + } + + public int getCode() { + return code; + } + + public void setCode(int code) { + this.code = code; + } + + public Data getData() { + Data data = new Data(); + data.className = getClass().getName(); + data.code = code; + data.message = getMessage(); + return data; + } + + @XmlRootElement(name="PKIException") + public static class Data { + + @XmlElement(name="ClassName") + public String className; + + @XmlElement(name="Code") + public int code; + + @XmlElement(name="Message") + public String message; + + @XmlElement(name="Attributes") + @XmlJavaTypeAdapter(MapAdapter.class) + public Map attributes = new LinkedHashMap(); + + public String getAttribute(String name) { + return attributes.get(name); + } + + public void setAttribute(String name, String value) { + attributes.put(name, value); + } + } + + public static class MapAdapter extends XmlAdapter> { + + public AttributeList marshal(Map map) { + AttributeList list = new AttributeList(); + for (Map.Entry entry : map.entrySet()) { + Attribute attribute = new Attribute(); + attribute.name = entry.getKey(); + attribute.value = entry.getValue(); + list.attributes.add(attribute); + } + return list; + } + + public Map unmarshal(AttributeList list) { + Map map = new LinkedHashMap(); + for (Attribute attribute : list.attributes) { + map.put(attribute.name, attribute.value); + } + return map; + } + } + + public static class AttributeList { + @XmlElement(name="Attribute") + public List attributes = new ArrayList(); + } + + public static class Attribute { + + @XmlAttribute + public String name; + + @XmlValue + public String value; + } + + @Provider + public static class Mapper implements ExceptionMapper { + + public Response toResponse(PKIException exception) { + // convert PKIException into HTTP response with XML content + return Response + .status(exception.getCode()) + .entity(exception.getData()) + .type(MediaType.APPLICATION_XML) + .build(); + } + } + + public static void main(String args[]) throws Exception { + Data data = new Data(); + data.className = PKIException.class.getName(); + data.code = Response.Status.INTERNAL_SERVER_ERROR.getStatusCode(); + data.message = "An error has occured"; + data.setAttribute("attr1", "value1"); + data.setAttribute("attr2", "value2"); + + JAXBContext context = JAXBContext.newInstance(Data.class); + Marshaller marshaller = context.createMarshaller(); + marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true); + marshaller.marshal(data, System.out); + } +} diff --git a/base/common/src/com/netscape/cms/servlet/base/PKIService.java b/base/common/src/com/netscape/cms/servlet/base/PKIService.java index de92d290a..a77846c68 100644 --- a/base/common/src/com/netscape/cms/servlet/base/PKIService.java +++ b/base/common/src/com/netscape/cms/servlet/base/PKIService.java @@ -38,7 +38,7 @@ import javax.ws.rs.core.UriInfo; import com.netscape.certsrv.apps.CMS; import com.netscape.certsrv.logging.IAuditor; import com.netscape.certsrv.logging.ILogger; -import com.netscape.cms.servlet.cert.model.CertificateData; +import com.netscape.cms.servlet.cert.model.CertData; /** * Base class for CMS RESTful resources @@ -90,9 +90,9 @@ public class PKIService { return builder.build(); } - public CertificateData createCertificateData(org.mozilla.jss.crypto.X509Certificate cert) + public CertData createCertificateData(org.mozilla.jss.crypto.X509Certificate cert) throws CertificateEncodingException { - CertificateData data = new CertificateData(); + CertData data = new CertData(); String b64 = HEADER + CMS.BtoA(cert.getEncoded()) + TRAILER; data.setEncoded(b64); return data; diff --git a/base/common/src/com/netscape/cms/servlet/base/UnauthorizedException.java b/base/common/src/com/netscape/cms/servlet/base/UnauthorizedException.java index 7dfa3d6d4..83803601c 100644 --- a/base/common/src/com/netscape/cms/servlet/base/UnauthorizedException.java +++ b/base/common/src/com/netscape/cms/servlet/base/UnauthorizedException.java @@ -23,7 +23,7 @@ import javax.ws.rs.core.Response; /** * @author Endi S. Dewata */ -public class UnauthorizedException extends CMSException { +public class UnauthorizedException extends PKIException { private static final long serialVersionUID = -2025082875126996556L; -- cgit