pegasus/src/Pegasus/Common/System.h - diff

Return to System.h CVS log

Up to [Pegasus] / pegasus / src / Pegasus / Common

Diff for /pegasus/src/Pegasus/Common/System.h between version 1.34 and 1.69

version 1.34, 2003/08/15 14:10:29

version 1.69, 2007/05/30 20:41:28

Line 1

//%/////////////////////////////////////////////////////////////////////////////

//%2006////////////////////////////////////////////////////////////////////////

// The Open Group, Tivoli Systems

// Company, L.P.; IBM Corp.; The Open Group; Tivoli Systems.

// IBM Corp.; EMC Corporation, The Open Group.

// IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group.

// EMC Corporation; VERITAS Software Corporation; The Open Group.

// EMC Corporation; Symantec Corporation; The Open Group.

// Permission is hereby granted, free of charge, to any person obtaining a copy

// of this software and associated documentation files (the "Software"), to

Line 21

Line 29

//==============================================================================

// Author: Mike Brasher (mbrasher@bmc.com)

// Modified By:

// Nag Boranna, Hewlett-Packard Company (nagaraja_boranna@hp.com)

// Modified By: Dave Rosckes (rosckes@us.ibm.com)

//%/////////////////////////////////////////////////////////////////////////////

#ifndef Pegasus_System_h

Line 37

Line 38

#include <Pegasus/Common/String.h>

#include <Pegasus/Common/Linkage.h>

#include <Pegasus/Common/Logger.h>

#include <sys/stat.h>

// Protocal Type

#define TCP "tcp"

PEGASUS_NAMESPACE_BEGIN

/** This is an opaque type which is used to represent dynamic library

#if defined(PEGASUS_OS_TYPE_WINDOWS)

handles returned by the System::loadDynamicLibrary() method and

#ifndef mode_t

accepted by the System::loadDynamicProcedure() method.

typedef unsigned long mode_t;

#endif

typedef struct DynamicLibraryHandle_* DynamicLibraryHandle;

#endif

/** This is an opaque type which is returned by System::loadDynamicSymbol().

#if defined (PEGASUS_OS_TYPE_UNIX) || (PEGASUS_OS_VMS)

Values of this type may be casted to the appropriate target type.

# ifndef PEGASUS_OS_OS400

# include <unistd.h>

#if !defined(PEGASUS_PLATFORM_ZOS_ZSERIES_IBM) && !defined(PEGASUS_PLATFORM_OS400_ISERIES_IBM)

# endif

typedef struct DynamicSymbolHandle_* DynamicSymbolHandle;

# include <fcntl.h> // File locking

# define PEGASUS_UID_T uid_t

# define PEGASUS_GID_T gid_t

#else

extern "C" {typedef int (* DynamicSymbolHandle)(void);}

# define PEGASUS_UID_T Uint32

# define PEGASUS_GID_T Uint32

#endif

// Protocal Type

#define TCP "tcp"

PEGASUS_NAMESPACE_BEGIN

/** The System class defines wrappers for operating system related calls.

These are only placed here if they are extremely light. These are

Line 82

Line 85

static void getCurrentTime(Uint32& seconds, Uint32& milliseconds);

/** Similar to getCurrentTime() above but get microseconds (rather than

milliseconds).

static void getCurrentTimeUsec(Uint32& seconds, Uint32& microseconds);

/** getCurrentASCIITime Gets time/date in a fixed format. The format is

YY MM DD-HH:MM:SS

@return Returns String with the ASCII time date.

Line 114

Line 122

static Boolean copyFile(const char* fromPath, const char* toPath);

/** Unix issue:<br><br><b>RTLD_<bah></b> issue. Currently Pegasus uses RTLD_NOW during

loading of the library if supported by OS. Previous to 2.2, Pegasus used RTLD_GLOBAL on Linux

- that behaviour is now deprecated.

static DynamicLibraryHandle loadDynamicLibrary(const char* fileName);

static void unloadDynamicLibrary(DynamicLibraryHandle libraryHandle);

static String dynamicLoadError(void);

static DynamicSymbolHandle loadDynamicSymbol(

DynamicLibraryHandle libraryHandle,

const char* symbolName);

static String getHostName();

static String getFullyQualifiedHostName ();

static String getSystemCreationClassName ();

static String getHostIP(const String &hostName);

static Uint32 _acquireIP(const char* hostname);

static Uint32 lookupPort(

const char * serviceName,

Uint32 defaultPort);

/**

Attempts to validate that the input hostName represents the same host as

the host represented by the value returned by the

getFullyQualifiedHostName() method.

@param hostName the host name to validate

@return True if the input hostName can be validated to represent the

same host;

False otherwise

static Boolean sameHost (const String & hostName);

/**

Attempts to find the given IP address(32bit) on any of the local defined

network interfaces

static Boolean isIpOnNetworkInterface(Uint32 inIP);

/**

Attempts to resolve a given hostname

this function possibly can take some as it can request information

from the DNS

@param resolvedNameIP On successful hostname resolution, this output

parameter contains the IP address that was determined.

@return true if successful, false if not successful.

static Boolean resolveHostNameAtDNS(

const char* hostname,

Uint32* resolvedNameIP);

/**

Attempts to resolve a given IP address

this function possibly can take some as it can request information

from the DNS

@param resolvedIP On successful hostname resolution, this output

parameter contains the IP address that was determined.

@return true if successful, false if not successful.

static Boolean resolveIPAtDNS(Uint32 ip_addr, Uint32 * resolvedIP);

/**

Bundling function used to determine if a given hostname or IP address

belongs to the local host

this function has the potential to take some time as it will possibly

use the DNS

static Boolean isLocalHost(const String& hostName);

static String getEffectiveUserName();

/**

Line 150

Line 197

/**

This function is used to encrypt the user's password.

The encryption is compatible with Apache's password file (generated using

The encryption is compatible with Apache's password file (generated

the htpasswd command )

using the htpasswd command)

@param password Password to be encrypted.

@param salt Two character string chosen from the set [a-zA-Z0-9./].

Line 176

Line 223

@param userName User name to be checked.

@return true if the user is a privileged user, else false

static Boolean isPrivilegedUser(const String userName);

static Boolean isPrivilegedUser(const String& userName);

/**

This function returns the privileged user name on the system.

@return the privileged user name

static String getPrivilegedUserName();

/**

This function is used to get the process ID of the calling process.

This function is used to verify whether the specified user is a member

of the specified user group.

@param userName User name to be verified.

@param groupName User group name.

@return true if the user is a member of the user group, false otherwise.

@throw InternalSystemError - If there is an error accessing the

specified user or group information.

static Boolean isGroupMember(const char* userName, const char* groupName);

/**

Gets the user and group IDs associated with the specified user.

@param userName User name for which to look up user and group IDs.

@param uid User ID for the specified user name.

@param gid Group ID for the specified user name.

@return True if the user and group IDs were retrieved

successfully, false otherwise.

#ifndef PEGASUS_OS_OS400

static Boolean lookupUserId(

const char* userName,

PEGASUS_UID_T& uid,

PEGASUS_GID_T& gid);

#endif

/**

Changes the process user context to the specified user and group.

IMPORTANT: This method uses non-reentrant functions and should only

be called in a single-threaded program.

@param userName User name to set as the process user context.

@param uid User ID to set as the process user context.

@param gid Group ID to set as the process group context.

@return True if the user context is successfully changed,

false otherwise.

#ifndef PEGASUS_OS_OS400

static Boolean changeUserContext_SingleThreaded(

const char* userName,

const PEGASUS_UID_T& uid,

const PEGASUS_GID_T& gid);

#endif

/**

This function is used to get the process ID of the calling process.

@return Process ID

static Uint32 getPID();

Line 220

Line 310

// Is absolute path?

static Boolean is_absolute_path(const char *path);

#if defined(PEGASUS_OS_HPUX)

/** Changes file permissions on the given file.

static Boolean bindVerbose;

@param path path of the file.

#endif

@param mode the bit-wise inclusive OR of the values for the desired

permissions.

/** This function is an abstraction for the openlog interface used in the Logger

@return true on success, false on error and errno is set appropriately.

class. Each platform intending to use system logs should support this interface

static Boolean changeFilePermissions(const char* path, mode_t mode);

/** Checks whether the specified file is a regular file owned by the

effective user for the current process.

@param path Path of the file to check.

@return True if the file is owned by the effective user for the

current process, false otherwise.

static void openlog(const String);

static Boolean verifyFileOwnership(const char* path);

/** This function is an abstraction for the syslog interface used in the Logger

/**

class. Each platform intending to use system logs should support this interface

Flag indicating whether shared libraries are loaded with the

BIND_VERBOSE option.

static void syslog(Uint32, const char *);

/** This function is an abstraction for the closelog interface used in the Logger

THIS FLAG IS USED ON HP-UX ONLY.

class. Each platform intending to use system logs should support this interface

static Boolean bindVerbose;

/**

Writes a message to the system log. This method encapsulates the

semantics of opening the system log, writing the specified message,

and closing the log.

@param ident An identifier to be prepended to the log messages

(typically a program name).

@param severity A severity value to be associated with the message.

Severity values are defined in Logger.h.

@param message A message to be written to the system log.

static void syslog(

const String& ident,

Uint32 severity,

const char* message);

static void openlog(

const char *ident,

int logopt,

int facility);

static void closelog();

// System ID constants for Logger::put and Logger::trace

Line 244

Line 362

// System ID constants for Logger::put and Logger::trace

static const String CIMLISTENER;

};

/**

The AutoFileLock class uses an advisory file lock to allow access to a

resource to be controlled.

class PEGASUS_COMMON_LINKAGE AutoFileLock

{

public:

AutoFileLock(const char* fileName);

~AutoFileLock();

private:

AutoFileLock();

AutoFileLock(const AutoFileLock&);

AutoFileLock& operator=(const AutoFileLock&);

#ifdef PEGASUS_OS_TYPE_UNIX

struct flock _fl;

int _fd;

#endif

};

PEGASUS_NAMESPACE_END

Legend:

Removed from v.1.34
changed lines
	Added in v.1.69

No CVS admin address has been configured