zms.ZMSRepositoryManager.ZMSRepositoryManager

class documentation

class ZMSRepositoryManager(ZMSItem.ZMSItem): (source)

Constructor: ZMSRepositoryManager()

Implements interfaces: Products.zms.IZMSConfigurationProvider.IZMSConfigurationProvider, Products.zms.IZMSRepositoryManager.IZMSRepositoryManager

View In Hierarchy

Undocumented

Method	`__init__`	Initialize the instance state.
Method	`commitChanges`	Export: Commit ZODB to repository.
Method	`get_conf_basepath`	Return conf basepath.
Method	`get_ignore_orphans`	Return ignore orphans.
Method	`get_modelfileset_from_disk`	Retrieve remote files from a repository provider.
Method	`get_models_from_disk`	Read repository data from a provider.
Method	`get_update_direction`	Returns direction of copying config files: Loading from file system (coloring ZMS changes) vs. Saving to file system (coloring filesystem changes)
Method	`manage_change`	Manage changes in the ZMS repository.
Method	`manage_options`	Handle the ZMI action 'manage_options'.
Method	`manage_sub_options`	Handle the ZMI action 'manage_sub_options'.
Method	`updateChanges`	Import: Update ZODB from repository.
Class Variable	`__ac_permissions__`	Undocumented
Class Variable	`__administratorPermissions__`	Undocumented
Class Variable	`manage`	Undocumented
Class Variable	`manage_main`	Undocumented
Class Variable	`manage_options_default_action`	Undocumented
Class Variable	`manage_sub_options__roles__`	Undocumented
Class Variable	`meta_type`	Undocumented
Class Variable	`zmi_icon`	Undocumented
Instance Variable	`id`	Undocumented
Instance Variable	`ignore_orphans`	Undocumented
Instance Variable	`update_direction`	Undocumented

def __init__(self): (source) ¶

Initialize the instance state.

def commitChanges(self, ids): (source) ¶

Export: Commit ZODB to repository.

def get_conf_basepath(self, id=''): (source) ¶

Return conf basepath.

def get_ignore_orphans(self): (source) ¶

Return ignore orphans.

def get_modelfileset_from_disk(self, provider): (source) ¶

Retrieve remote files from a repository provider.

This method retrieves a list of remote files from the specified provider by constructing the base path configuration and delegating to the repository utility function.

Parameters
provider:object	The repository provider object containing configuration and connection details for accessing remote files
Returns
list	A list of remote files available from the provider
See Also
`repositoryutil.get_modelfileset_from_disk`
`get_conf_basepath`

def get_models_from_disk(self, provider): (source) ¶

Read repository data from a provider.

Implements the 'get_models_from_disk' interface. This method retrieves repository information from the specified provider by reading the repository structure from the configured base path.

Parameters
provider:Provider	The provider object from which to read the repository. Must have an 'id' attribute.
Returns
dict	Repository data read from the provider's base path.
See Also
repositoryutil.get_models_from_disk()

def get_update_direction(self): (source) ¶

Returns direction of copying config files: Loading from file system (coloring ZMS changes) vs. Saving to file system (coloring filesystem changes)

def manage_change(self, btn, lang, REQUEST=None, RESPONSE=None): (source) ¶

Manage changes in the ZMS repository.

For 'save': Save current settings (ignore orphans, update direction) and return with confirmation message.
For 'commit': Commit changes from ZODB to repository and return with success/failure messages.
For 'override'/'update': Update ZODB from repository (with or without override) and return with success/failure messages.
Redirect to manage_main with appropriate messages in query parameters.
Messages are localized using getZMILangStr and include lists of successfully processed and failed items.
Events 'beforeCommitRepositoryEvt', 'afterCommitRepositoryEvt', 'beforeUpdateRepositoryEvt', and 'afterUpdateRepositoryEvt' are triggered at appropriate stages of processing.

Parameters
btn:str	Action button clicked ('save', 'commit', 'override', 'update')
lang:str	Language code for messages
REQUEST:ZPublisher.HTTPRequest	Current request object
RESPONSE:ZPublisher.HTTPResponse	Current response object

def manage_options(self): (source) ¶

Handle the ZMI action 'manage_options'.

def manage_sub_options(self): (source) ¶

Handle the ZMI action 'manage_sub_options'.

def updateChanges(self, ids, override=False): (source) ¶

Import: Update ZODB from repository.

If override is False, only update if there are changes in the repository compared to ZODB (highlighted filesystem changes)
If override is True, update regardless of changes (highlighted ZMS changes)

__ac_permissions__ = (source) ¶

Undocumented

__administratorPermissions__: tuple[str, ...] = (source) ¶

Undocumented

manage = (source) ¶

Undocumented

manage_main = (source) ¶

Undocumented

manage_options_default_action: str = (source) ¶

Undocumented

manage_sub_options__roles__ = (source) ¶

Undocumented