class UMCConnection(object):
"""
Connection to a |UMC| server.
:param str hostname: The host name of the |UMC| server.
:param str username: The user name.
:param str password: The user password.
:param error_handler: A function accepting the error message as the single argument.
"""
def __init__(self, host, username=None, password=None, error_handler=None):
# type: (str, Optional[str], Optional[str], Optional[Callable[[str], None]]) -> None
self.client = Client(host, username, password)
self._error_handler = error_handler
self.build_data = self.client._Client__build_data
@property
def _headers(self):
# type: () -> Dict[str, str]
"""
Return |HTTP| request headers.
:returns: A dictionary containing the |HTTP| headers.
:rtype: dict
"""
return self._client._headers
@property
def _host(self):
# type: () -> str
"""
Return the host name of the |UMC| server,
:returns: the host name.
:rtype: str
"""
return self.client.hostname
def get_connection(self):
# type: () -> HTTPSConnection
"""
Return the underlying connection object.
:returns: The connection.
:rtype: HTTPSConnection
"""
return self._client._get_connection()
@classmethod
def get_machine_connection(cls, error_handler=None):
# type: (Optional[Callable[[str], None]]) -> Optional[UMCConnection]
"""
Creates a connection with the credentials of the local host
to the DC Master.
:param error_handler: A function accepting the error message as the single argument.
:returns: The connection object or None in case of errors.
:rtype: UMCConnection
"""
try:
connection = cls(ucr.get('ldap/master'))
connection.client.authenticate_with_machine_account()
return connection
except ConnectionError as exc:
if error_handler:
error_handler('Could not connect to UMC on %s: %s' % (ucr.get('ldap/master'), exc.reason))
def auth(self, username, password, auth_type=None):
# type: (str, str, Optional[str]) -> None
"""
Tries to authenticate against the host and preserves the
cookie. Has to be done only once (but keep in mind that the
session probably expires after 10 minutes of inactivity)
:param str username: The user name.
:param str password: The user password.
:param str auth_type: The authentication type, e.g. `???`.
"""
try:
self.client.umc_auth(username, password, auth_type=auth_type)
except HTTPError as exc:
raise HTTPException(str(exc))
def request(self, url, data=None, flavor=None, command='command'):
# type: (str, Any, Optional[str], str) -> str
"""
Sends a request and returns the data from the response.
:param str url: The partial |URL| of the |UMC| function to invoke. See the |XML| file of the |UMC| module.
:param data: The data to send.
:param flavor: Some |UMC| modules support flavors, e.g. the |UDM| module for sub-types.
:param str command: may be anything that |UMCP| understands, especially:
* `command` (default)
* `get` (and `url` could be `ucr` then)
* `set` (and `url` would be `` and `data` could be `{'locale':'de_DE'}`)
* `upload` (`url` could be `udm/license/import`)
:returns: the result of the response.
:rtype: str
"""
if data is None:
data = {}
try:
if command in ('command', 'upload'):
response = self.client.umc_command(url, data, flavor)
elif command == 'get':
response = self.client.umc_get(url)
elif command == 'set':
response = self.client.umc_set(data)
except Forbidden:
raise NotImplementedError('command forbidden: %s' % url)
except HTTPError as exc:
if self._error_handler:
self._error_handler(str(exc))
raise HTTPException(str(exc))
return response.result
class UMCConnection(object):
def __init__(self, host, username=None, password=None, error_handler=None):
self.client = Client(host, username, password)
self._error_handler = error_handler
self.build_data = self.client._Client__build_data
@property
def _headers(self):
return self._client._headers
@property
def _host(self):
return self.client.hostname
def get_connection(self):
return self._client._get_connection()
@classmethod
def get_machine_connection(cls, error_handler=None):
'''Creates a connection with the credentials of the local host
to the DC Master'''
try:
connection = cls(ucr.get('ldap/master'))
connection.client.authenticate_with_machine_account()
return connection
except ConnectionError as exc:
if error_handler:
error_handler('Could not connect to UMC on %s: %s' %
(ucr.get('ldap/master'), exc.reason))
def auth(self, username, password, auth_type=None):
'''Tries to authenticate against the host and preserves the
cookie. Has to be done only once (but keep in mind that the
session probably expires after 10 minutes of inactivity)'''
try:
self.client.umc_auth(username, password, auth_type=auth_type)
except HTTPError as exc:
raise HTTPException(str(exc))
def request(self, url, data=None, flavor=None, command='command'):
'''Sends a request and returns the data from the response. url
as in the XML file of that UMC module.
command may be anything that UMCP understands, especially:
* command (default)
* get (and url could be 'ucr' then)
* set (and url would be '' and data could be {'locale':'de_DE'})
* upload (url could be 'udm/license/import')
'''
if data is None:
data = {}
try:
if command in ('command', 'upload'):
response = self.client.umc_command(url, data, flavor)
elif command == 'get':
response = self.client.umc_get(url)
elif command == 'set':
response = self.client.umc_set(data)
except Forbidden:
raise NotImplementedError('command forbidden: %s' % url)
except HTTPError as exc:
if self._error_handler:
self._error_handler(str(exc))
raise HTTPException(str(exc))
return response.result
