1 j.alex 1.2 //%2006////////////////////////////////////////////////////////////////////////
  2            //
  3            // Copyright (c) 2000, 2001, 2002 BMC Software; Hewlett-Packard Development
  4            // Company, L.P.; IBM Corp.; The Open Group; Tivoli Systems.
  5            // Copyright (c) 2003 BMC Software; Hewlett-Packard Development Company, L.P.;
  6            // IBM Corp.; EMC Corporation, The Open Group.
  7            // Copyright (c) 2004 BMC Software; Hewlett-Packard Development Company, L.P.;
  8            // IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group.
  9            // Copyright (c) 2005 Hewlett-Packard Development Company, L.P.; IBM Corp.;
 10            // EMC Corporation; VERITAS Software Corporation; The Open Group.
 11            // Copyright (c) 2006 Hewlett-Packard Development Company, L.P.; IBM Corp.;
 12            // EMC Corporation; Symantec Corporation; The Open Group.
 13            //
 14            // Permission is hereby granted, free of charge, to any person obtaining a copy
 15            // of this software and associated documentation files (the "Software"), to
 16            // deal in the Software without restriction, including without limitation the
 17            // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 18            // sell copies of the Software, and to permit persons to whom the Software is
 19            // furnished to do so, subject to the following conditions:
 20            //
 21            // THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN
 22 j.alex 1.2 // ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS PROVIDED
 23            // "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
 24            // LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
 25            // PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 26            // HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
 27            // ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 28            // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 29            //
 30            //==============================================================================
 31            //
 32            // Author: John Alex, IBM         (johnalex@us.ibm.com)
 33            //
 34            //%/////////////////////////////////////////////////////////////////////////////
 35            
 36            #ifndef Pegasus_StressTestControllerException_h
 37            #define Pegasus_StressTestControllerException_h
 38            
 39            #include <Clients/cliutils/CommandException.h>
 40            
 41            
 42            PEGASUS_NAMESPACE_BEGIN
 43 j.alex 1.2 
 44            /** 
 45              
 46                StressTestControllerException signals that an exception has occurred in 
 47                executing the StressTestController command.  
 48              
 49              
 50             */
 51            class StressTestControllerException : public CommandException 
 52            {
 53            public:
 54                /**
 55                  
 56                    Constructs an StressTestControllerException with a message corresponding
 57                    to the specified exception ID.
 58                  
 59                    @param  ID                the integer exception identifier
 60                  
 61                 */
 62                StressTestControllerException (Uint32 ID);
 63            
 64 j.alex 1.2 
 65                /**
 66                  
 67                    Constructs an StressTestControllerException with the specified message.
 68                  
 69                    @param  exceptionMessage  a string containing the exception message
 70                  
 71                 */
 72                StressTestControllerException (const String& exceptionMessage);
 73            
 74                //
 75                //  Exception identifiers
 76                //
 77                //  These are used to index into the messageStrings array to retrieve the 
 78                //  appropriate exception message string.  When a new identifier is added, 
 79                //  the messageStrings array and MAX_ID must be updated appropriately.
 80                //
 81                
 82                /**
 83                  
 84                    Default exception identifier.  This identifier is used if the specified
 85 j.alex 1.2         identifier is out of range.  This identifier corresponds to a default
 86                    (generic) message in the array of exception message strings.
 87                  
 88                 */
 89                static const Uint32 DEFAULT_ID;
 90                
 91                /**
 92                  
 93                    Minimum valid exception identifier.
 94                  
 95                 */
 96                static const Uint32 MIN_ID;
 97            
 98                /**
 99            
100                    Exception identifier indicating "Syntax Error" with client option.
101            
102                */
103            
104                static const Uint32 INVALID_OPTION;
105            
106 j.alex 1.2     /**
107            
108                    Exception identifier indicating "Syntax Error" with client option 
109                    operator.
110            
111                */
112                static const Uint32 INVALID_OPERATOR;
113            
114                /**
115            
116                    Exception identifier indicating "Missing closing square brace".
117            
118                */
119                static const Uint32 MISSING_BRACE;
120            
121                /**
122            
123                    Exception identifier indicating "Missing value for client option".
124            
125                */
126                static const Uint32 MISSING_VALUE;
127 j.alex 1.2 
128            
129                static const Uint32 MAX_ID;
130            
131            private:
132                /**
133                  
134                    Exception message strings.  The exception identifier is used as an
135                    index into this array to retrieve the appropriate exception message 
136                    string.  When a new identifier is added, this array must be updated
137                    appropriately.
138                  
139                 */
140                static const char*  _messageStrings [];
141            };
142            
143            PEGASUS_NAMESPACE_END
144            
145            #endif  /* Pegasus_StressTestControllerException_h */