1 martin 1.3 //%LICENSE////////////////////////////////////////////////////////////////

  2 martin 1.4 //

  3 martin 1.3 // Licensed to The Open Group (TOG) under one or more contributor license
  4            // agreements.  Refer to the OpenPegasusNOTICE.txt file distributed with
  5            // this work for additional information regarding copyright ownership.
  6            // Each contributor licenses this file to you under the OpenPegasus Open
  7            // Source License; you may not use this file except in compliance with the
  8            // License.

  9 martin 1.4 //

 10 martin 1.3 // Permission is hereby granted, free of charge, to any person obtaining a
 11            // copy of this software and associated documentation files (the "Software"),
 12            // to deal in the Software without restriction, including without limitation
 13            // the rights to use, copy, modify, merge, publish, distribute, sublicense,
 14            // and/or sell copies of the Software, and to permit persons to whom the
 15            // Software is furnished to do so, subject to the following conditions:

 16 martin 1.4 //

 17 martin 1.3 // The above copyright notice and this permission notice shall be included
 18            // in all copies or substantial portions of the Software.

 19 martin 1.4 //

 20 martin 1.3 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS

 21 martin 1.4 // OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF

 22 martin 1.3 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 23            // IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 24            // CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 25            // TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 26            // SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

 27 martin 1.4 //

 28 martin 1.3 //////////////////////////////////////////////////////////////////////////

 29 j.alex 1.2 //
 30            // Author: John Alex, IBM         (johnalex@us.ibm.com)
 31            //
 32            //%/////////////////////////////////////////////////////////////////////////////
 33            
 34            #ifndef Pegasus_StressTestControllerException_h
 35            #define Pegasus_StressTestControllerException_h
 36            
 37            #include <Clients/cliutils/CommandException.h>
 38            
 39            
 40            PEGASUS_NAMESPACE_BEGIN
 41            

 42 kumpf  1.5 /**
 43            
 44                StressTestControllerException signals that an exception has occurred in
 45                executing the StressTestController command.
 46            
 47            

 48 j.alex 1.2  */

 49 kumpf  1.5 class StressTestControllerException : public CommandException

 50 j.alex 1.2 {
 51            public:
 52                /**

 53 kumpf  1.5 

 54 j.alex 1.2         Constructs an StressTestControllerException with a message corresponding
 55                    to the specified exception ID.

 56 kumpf  1.5 

 57 j.alex 1.2         @param  ID                the integer exception identifier

 58 kumpf  1.5 

 59 j.alex 1.2      */
 60                StressTestControllerException (Uint32 ID);
 61            
 62            
 63                /**

 64 kumpf  1.5 

 65 j.alex 1.2         Constructs an StressTestControllerException with the specified message.

 66 kumpf  1.5 

 67 j.alex 1.2         @param  exceptionMessage  a string containing the exception message

 68 kumpf  1.5 

 69 j.alex 1.2      */
 70                StressTestControllerException (const String& exceptionMessage);
 71            
 72                //
 73                //  Exception identifiers
 74                //

 75 kumpf  1.5     //  These are used to index into the messageStrings array to retrieve the
 76                //  appropriate exception message string.  When a new identifier is added,

 77 j.alex 1.2     //  the messageStrings array and MAX_ID must be updated appropriately.
 78                //

 79 kumpf  1.5 

 80 j.alex 1.2     /**

 81 kumpf  1.5 

 82 j.alex 1.2         Default exception identifier.  This identifier is used if the specified
 83                    identifier is out of range.  This identifier corresponds to a default
 84                    (generic) message in the array of exception message strings.

 85 kumpf  1.5 

 86 j.alex 1.2      */
 87                static const Uint32 DEFAULT_ID;

 88 kumpf  1.5 

 89 j.alex 1.2     /**

 90 kumpf  1.5 

 91 j.alex 1.2         Minimum valid exception identifier.

 92 kumpf  1.5 

 93 j.alex 1.2      */
 94                static const Uint32 MIN_ID;
 95            
 96                /**
 97            
 98                    Exception identifier indicating "Syntax Error" with client option.
 99            
100                */
101            
102                static const Uint32 INVALID_OPTION;
103            
104                /**
105            

106 kumpf  1.5         Exception identifier indicating "Syntax Error" with client option

107 j.alex 1.2         operator.
108            
109                */
110                static const Uint32 INVALID_OPERATOR;
111            
112                /**
113            
114                    Exception identifier indicating "Missing closing square brace".
115            
116                */
117                static const Uint32 MISSING_BRACE;
118            
119                /**
120            
121                    Exception identifier indicating "Missing value for client option".
122            
123                */
124                static const Uint32 MISSING_VALUE;
125            
126            
127                static const Uint32 MAX_ID;
128 j.alex 1.2 
129            private:
130                /**

131 kumpf  1.5 

132 j.alex 1.2         Exception message strings.  The exception identifier is used as an

133 kumpf  1.5         index into this array to retrieve the appropriate exception message

134 j.alex 1.2         string.  When a new identifier is added, this array must be updated
135                    appropriately.

136 kumpf  1.5 

137 j.alex 1.2      */
138                static const char*  _messageStrings [];
139            };
140            
141            PEGASUS_NAMESPACE_END
142            
143            #endif  /* Pegasus_StressTestControllerException_h */