summaryrefslogtreecommitdiffstats
path: root/pki/base/common/src/com/netscape/certsrv/selftests/EInvalidSelfTestException.java
diff options
context:
space:
mode:
Diffstat (limited to 'pki/base/common/src/com/netscape/certsrv/selftests/EInvalidSelfTestException.java')
-rw-r--r--pki/base/common/src/com/netscape/certsrv/selftests/EInvalidSelfTestException.java225
1 files changed, 225 insertions, 0 deletions
diff --git a/pki/base/common/src/com/netscape/certsrv/selftests/EInvalidSelfTestException.java b/pki/base/common/src/com/netscape/certsrv/selftests/EInvalidSelfTestException.java
new file mode 100644
index 000000000..b38b574cf
--- /dev/null
+++ b/pki/base/common/src/com/netscape/certsrv/selftests/EInvalidSelfTestException.java
@@ -0,0 +1,225 @@
+// --- 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 statement //
+///////////////////////
+
+package com.netscape.certsrv.selftests;
+
+
+///////////////////////
+// import statements //
+///////////////////////
+
+import com.netscape.certsrv.base.*;
+
+
+//////////////////////
+// class definition //
+//////////////////////
+
+/**
+ * This class implements an invalid self test exception.
+ * EInvalidSelfTestExceptions are derived from ESelfTestExceptions
+ * in order to allow users to easily do self tests without try-catch clauses.
+ *
+ * EInvalidSelfTestExceptions should be caught by SelfTestSubsystem managers.
+ * <P>
+ *
+ * @version $Revision$, $Date$
+ */
+public class EInvalidSelfTestException
+ extends ESelfTestException {
+ ////////////////////////
+ // default parameters //
+ ////////////////////////
+
+
+
+ ///////////////////////
+ // helper parameters //
+ ///////////////////////
+
+ private String mInstanceName = null;
+ private String mInstanceStore = null;
+ private String mInstanceParameter = null;
+ private String mInstanceValue = null;
+
+ //////////////////////////////////////////
+ // EInvalidSelfTestException parameters //
+ //////////////////////////////////////////
+
+
+
+ ///////////////////////////////////////////////
+ // ESelfTestException parameters (inherited) //
+ ///////////////////////////////////////////////
+
+
+
+ /////////////////////
+ // default methods //
+ /////////////////////
+
+ /**
+ * Constructs an "invalid" self test exception.
+ * <P>
+ *
+ * @param instanceName invalid "instanceName" exception details
+ */
+ public EInvalidSelfTestException(String instanceName) {
+ super("The self test plugin named "
+ + instanceName
+ + " is invalid.");
+
+ // strip preceding/trailing whitespace
+ // from passed-in String parameters
+ if (instanceName != null) {
+ instanceName = instanceName.trim();
+ }
+
+ // store passed-in parameters for use by helper methods
+ mInstanceName = instanceName;
+ }
+
+ /**
+ * Constructs a "invalid" self test exception where the value is always
+ * invalid from a name/value pair
+ * <P>
+ *
+ * @param instanceName invalid "instanceName" exception details
+ * @param instanceValue invalid "instanceValue" exception details
+ */
+ public EInvalidSelfTestException(String instanceName,
+ String instanceValue) {
+ super("The self test plugin named "
+ + instanceName
+ + " contains a value "
+ + instanceValue
+ + " which is invalid.");
+
+ // strip preceding/trailing whitespace
+ // from passed-in String parameters
+ if (instanceName != null) {
+ instanceName = instanceName.trim();
+ }
+ if (instanceValue != null) {
+ instanceValue = instanceValue.trim();
+ }
+
+ // store passed-in parameters for use by helper methods
+ mInstanceName = instanceName;
+ mInstanceValue = instanceValue;
+ }
+
+ /**
+ * Constructs an "invalid" self test exception where the parameter is always
+ * invalid from a substore.parameter/value pair; (the value passed in may
+ * be null).
+ * <P>
+ *
+ * @param instanceStore invalid "instanceStore" exception details
+ * @param instanceParameter invalid "instanceParameter" exception details
+ * @param instanceValue invalid "instanceValue" exception details
+ * (may be null)
+ */
+ public EInvalidSelfTestException(String instanceStore,
+ String instanceParameter,
+ String instanceValue) {
+ super("The self test plugin parameter named "
+ + instanceStore + "." + instanceParameter
+ + " is invalid.");
+
+ // strip preceding/trailing whitespace
+ // from passed-in String parameters
+ if (instanceStore != null) {
+ instanceStore = instanceStore.trim();
+ }
+ if (instanceParameter != null) {
+ instanceParameter = instanceParameter.trim();
+ }
+ if (instanceValue != null) {
+ instanceValue = instanceValue.trim();
+ }
+
+ // store passed-in parameters for use by helper methods
+ mInstanceStore = instanceStore;
+ mInstanceParameter = instanceParameter;
+ mInstanceValue = instanceValue;
+ }
+
+ ////////////////////
+ // helper methods //
+ ////////////////////
+
+ /**
+ * Returns the instance name associated with this self test.
+ * <P>
+ *
+ * @return name portion of the name/value pair
+ */
+ public String getInstanceName() {
+ return mInstanceName;
+ }
+
+ /**
+ * Returns the store associated with this self test.
+ * <P>
+ *
+ * @return substore portion of the substore.parameter/value pair
+ */
+ public String getInstanceStore() {
+ return mInstanceStore;
+ }
+
+ /**
+ * Returns the parameter associated with this self test.
+ * <P>
+ *
+ * @return parameter portion of the substore.parameter/value pair
+ */
+ public String getInstanceParameter() {
+ return mInstanceParameter;
+ }
+
+ /**
+ * Returns the value associated with this self test.
+ * <P>
+ *
+ * @return value portion of the name/value pair
+ */
+ public String getInstanceValue() {
+ return mInstanceValue;
+ }
+
+ ///////////////////////////////////////
+ // EInvalidSelfTestException methods //
+ ///////////////////////////////////////
+
+
+
+ ////////////////////////////////////////////
+ // ESelfTestException methods (inherited) //
+ ////////////////////////////////////////////
+
+ /* Note that all of the following ESelfTestException methods
+ * are inherited from the ESelfTestException class:
+ *
+ * public ESelfTestException( String msg );
+ */
+}
+