1 karl  1.6 //%2006////////////////////////////////////////////////////////////////////////

  2 karl  1.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 karl  1.3 // Copyright (c) 2005 Hewlett-Packard Development Company, L.P.; IBM Corp.;
 10           // EMC Corporation; VERITAS Software Corporation; The Open Group.

 11 karl  1.6 // Copyright (c) 2006 Hewlett-Packard Development Company, L.P.; IBM Corp.;
 12           // EMC Corporation; Symantec Corporation; The Open Group.

 13 karl  1.2 //
 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           // 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 kumpf 1.4 //
 32           // Author: Tony Fiorentino (fiorentino_tony@emc.com)
 33           //
 34           // Modified By: Keith Petley (keithp@veritas.com)

 35 joyce.j 1.5 //              Josephine Eskaline Joyce, IBM (jojustin@in.ibm.com) for Bug 3123

 36 kumpf   1.4 //
 37             //%/////////////////////////////////////////////////////////////////////////////
 38             
 39             #ifndef Pegasus_CIMServerDescription_h
 40             #define Pegasus_CIMServerDescription_h
 41             
 42             #include <Pegasus/Common/Config.h>
 43             #include <Pegasus/Common/String.h>
 44             #include <Pegasus/Common/Attribute.h>
 45             #include <Pegasus/Common/Linkage.h>
 46             
 47             PEGASUS_NAMESPACE_BEGIN
 48             
 49             class PEGASUS_COMMON_LINKAGE CIMServerDescription
 50             {
 51             public:
 52             
 53                 /** Constructor for a CIMServerDescription object.
 54                 */
 55                 CIMServerDescription();
 56             
 57 kumpf   1.4     /** Constructor for a CIMServerDescription object.
 58                     @param url Url that identifies this connection description.
 59                 */
 60                 CIMServerDescription(const String& url);
 61             
 62                 /** Destructor for a CIMServerDescription object.
 63                 */
 64                 ~CIMServerDescription();
 65             
 66                 /** Returns the URL for this description.
 67                     @return  String that contains the Url for this connection description.
 68                 */
 69                 String getUrl();
 70             
 71                 /** Returns an attribute value as a string.
 72                     @param  attributeName Attribute name of attribute.
 73                     @param  defaultValue Default attribute value to return if empty or
 74                     malformed.
 75                     @return String that contains an attribute value.
 76                 */
 77                 String getValue(
 78 kumpf   1.4         const String& attributeName, 
 79                     const String& defaultValue) const;
 80             
 81                 /** Returns an attribute value Array
 82                     @param  attributeName Attribute name of attribute.
 83                     @param  attributeValues Array<String> into which results are copied
 84                     @return True if attributeName was found, false otherwise.
 85                     Note, a true return value with an empty attributeValues array
 86                     indicates the tag had no attribute values (ie a keyword).
 87                 */
 88                 Boolean getValues(
 89                     const String& attributeName,
 90                     Array<String>& attributeValues) const;
 91             
 92                 /** Returns an array of attribute.
 93                     @return Array that contains contains attributes for this connection
 94                     description.
 95                 */
 96                 Array<Attribute> getAttributes() const;
 97             
 98                 /** Sets an array of attributes for this description.
 99 kumpf   1.4         @param attributes Array that contains attributes for this connection
100                     description.
101                 */
102                 void setAttributes(const Array<Attribute>& attributes);
103             
104             private:
105                 String _serviceLocationTcp;
106                 String _host;
107                 Uint32 _port;
108                 Array<Attribute> _attributes;
109             };
110             
111             #define PEGASUS_ARRAY_T CIMServerDescription
112             #include <Pegasus/Common/ArrayInter.h>
113             #undef PEGASUS_ARRAY_T
114             
115             PEGASUS_NAMESPACE_END
116             
117             #endif /* Pegasus_CIMServerDescription_h */