CSharedData.h   [plain text]

/*
 * Copyright (c) 2002 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this
 * file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_LICENSE_HEADER_END@
 */

/*!
 * @header CSharedData
 */

#ifndef __CSharedData_h__
#define	__CSharedData_h__	1

#include <DirectoryServiceCore/PrivateTypes.h>
#include <DirectoryServiceCore/SharedConsts.h>

#define		kstrDefaultLocalNodeName			"/Local/Default"
#define		kstrBSDLocalNodeName				"/BSD/local"

#define		kstrNIDefaultLocalNodeName			"/NetInfo/DefaultLocalNode"
#define		kstrAuthenticationNodeName			"/Search"
#define		kstrContactsNodeName				"/Search/Contacts"
#define		kstrNetworkNodeName					"/Search/Network"
#define		kstrAuthenticationConfigFilePrefix	"SearchNodeConfig"
#define		kstrContactsConfigFilePrefix		"ContactsNodeConfig"
#define		kstrCacheNodeName					"/Cache"
#define		kstrCacheStoreNodeName				"/Cache/Store"

/*!
 * @defined kDSNAttrDefaultLDAPPaths
 * @discussion Represents the list of default LDAP paths used by the search node.
 *     Typically this list will be initially obtained from the host DHCP server
 */
#define		kDSNAttrDefaultLDAPPaths		"dsAttrTypeStandard:DefaultLDAPPaths"

typedef enum {
// LDAPv2 Plugin Request Codes
	eDSCustomCallLDAPv2ReadConfigSize				= 66,
	eDSCustomCallLDAPv2ReadConfigData				= 77,
	eDSCustomCallLDAPv2WriteConfigData				= 88,
	eDSCustomCallLDAPv2Reinitialize					= 99,
	
// LDAPv3 Plugin Request Codes
	eDSCustomCallLDAPv3WriteServerMappings			= 55,
	//eDSCustomCallLDAPv3ReadServerMappingsSize		= 56,
	//eDSCustomCallLDAPv3ReadServerMappingsData		= 57,
	eDSCustomCallLDAPv3ReadConfigSize				= 66,
	eDSCustomCallLDAPv3ReadConfigData				= 77,
	eDSCustomCallLDAPv3ReadConfigDataServerList		= 80,
	eDSCustomCallLDAPv3WriteConfigData				= 88,
	eDSCustomCallLDAPv3Reinitialize					= 99,
	eDSCustomCallLDAPv3AddServerConfig				= 111,
	eDSCustomCallLDAPv3NewServerDiscovery			= 200,
	eDSCustomCallLDAPv3NewServerDiscoveryNoDupes	= 201,
	eDSCustomCallLDAPv3NewServerVerifySettings		= 202,
	eDSCustomCallLDAPv3NewServerGetConfig			= 203,
	eDSCustomCallLDAPv3NewServerBind				= 204,
	eDSCustomCallLDAPv3NewServerForceBind			= 205,
	eDSCustomCallLDAPv3NewServerAddConfig			= 206,
	eDSCustomCallLDAPv3UnbindServerConfig			= 207,
	eDSCustomCallLDAPv3ForceUnbindServerConfig		= 208,
	eDSCustomCallLDAPv3RemoveServerConfig			= 209,
	eDSCustomCallLDAPv3NewServerBindOther			= 210,
	eDSCustomCallLDAPv3NewServerForceBindOther		= 211,
	eDSCustomCallLDAPv3CurrentAuthenticatedUser		= 212,
	
// Extended Record Calls - can be used by multiple plug-ins
	eDSCustomCallExtendedRecordCallsAvailable		= 1000,
	eDSCustomCallCreateRecordWithAttributes			= 1001,
	eDSCustomCallSetAttributes						= 1002,
	eDSCustomCallDeleteRecordAndCredentials			= 1003,
	
// Search Plugin Request Codes
	eDSCustomCallSearchSetPolicyAutomatic			= 111,
	eDSCustomCallSearchSetPolicyLocalOnly			= 222,
	eDSCustomCallSearchSetPolicyCustom				= 333,
	eDSCustomCallSearchSetCustomNodeList			= 444,
	eDSCustomCallSearchReadDHCPLDAPSize				= 555,
	eDSCustomCallSearchReadDHCPLDAPData				= 556,
	eDSCustomCallSearchWriteDHCPLDAPData			= 557,
	eDSCustomCallSearchSubNodesUnreachable			= 666,
	eDSCustomCallSearchCheckForAugmentRecord		= 777,

// Configure Plugin Request Codes
	eDSCustomCallConfigureGetAuthRef				= 111,
	eDSCustomCallConfigureCheckVersion				= 222,
	eDSCustomCallConfigureCheckAuthRef				= 223,
	eDSCustomCallConfigureDestroyAuthRef			= 333,
	eDSCustomCallConfigureSCGetKeyPathValueSize		= 444,
	eDSCustomCallConfigureSCGetKeyPathValueData		= 445,
	eDSCustomCallConfigureSCGetKeyValueSize			= 446,
	eDSCustomCallConfigureSCGetKeyValueData			= 447,
	eDSCustomCallConfigureWriteSCConfigData			= 555,
	eDSCustomCallActivatePerfMonitor				= 666,
	eDSCustomCallDeactivatePerfMonitor				= 667,
	eDSCustomCallDumpStatsPerfMonitor				= 668,
	eDSCustomCallFlushStatsPerfMonitor				= 669,
	eDSCustomCallConfigureToggleDSProxy				= 777,
	eDSCustomCallConfigureIsBSDLocalUsersAndGroupsEnabled = 780,
	eDSCustomCallConfigureEnableBSDLocalUsersAndGroups	= 781,
	eDSCustomCallConfigureDisableBSDLocalUsersAndGroups= 782,
	eDSCustomCallConfigureLocalMountRecordsChanged	= 888,
	eDSCustomCallConfigureSuspendCacheFlushes		= 900,
	eDSCustomCallConfigureEnableCacheFlushes		= 901,
	eDSCustomCallTogglePlugInStateBase				= 1000,
	
// BaseDirectoryPlugin Request Codes
	eDSCustomCallReadPluginConfigSize				= 66,
	eDSCustomCallReadPluginConfigData				= 77,
	eDSCustomCallWritePluginConfigData				= 88,
	eDSCustomCallVerifyPluginConfigData				= 99,
	
// Cache Plugin request codes
	eDSCustomCallCacheRegisterLocalSearchPID		= 10000,	// means only local plugins used during lookups
	eDSCustomCallCacheUnregisterLocalSearchPID		= 10001

} tPluginCustomCallRequestCode;

#ifdef __cplusplus
class CShared
{
public:
	static	void		LogIt				( UInt32 inMsgType, const char *inFmt, ... );
	static	void		LogItWithPriority	( UInt32 inSignature, UInt32 inMsgType, const char *inFmt, ... );
};
#endif

__BEGIN_DECLS
void dsSetNodeCacheAvailability( char *inNodeName, int inAvailable );
void dsFlushLibinfoCache( void );
void dsFlushMembershipCache( void );
__END_DECLS

#endif // __CSharedData_h__