networkapi.api_ogp package

Submodules

networkapi.api_ogp.exceptions module

exception networkapi.api_ogp.exceptions.ObjectGroupPermissionError(msg)[source]

Bases: rest_framework.exceptions.APIException

status_code = 500
exception networkapi.api_ogp.exceptions.ObjectGroupPermissionGeneralError(msg)[source]

Bases: rest_framework.exceptions.APIException

status_code = 500
exception networkapi.api_ogp.exceptions.ObjectGroupPermissionGeneralNotFoundError(msg)[source]

Bases: rest_framework.exceptions.APIException

status_code = 404
exception networkapi.api_ogp.exceptions.ObjectGroupPermissionNotFoundError(msg)[source]

Bases: rest_framework.exceptions.APIException

status_code = 404
exception networkapi.api_ogp.exceptions.ObjectTypeError(msg)[source]

Bases: rest_framework.exceptions.APIException

status_code = 500
exception networkapi.api_ogp.exceptions.ObjectTypeNotFoundError(msg)[source]

Bases: rest_framework.exceptions.APIException

status_code = 404

networkapi.api_ogp.models module

class networkapi.api_ogp.models.ObjectGroupPermission(*args, **kwargs)[source]

Bases: networkapi.models.BaseModel.BaseModel

ObjectGroupPermission(id, user_group_id, object_type_id, object_value, read, write, change_config, delete)

exception DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

exception ObjectGroupPermission.MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

ObjectGroupPermission.create_perms(obj_map, object_value, object_type, user)[source]
ObjectGroupPermission.create_v3(perm)[source]
ObjectGroupPermission.delete_v3()[source]
classmethod ObjectGroupPermission.get_by_object(object_value, object_type)[source]

“Get Object Group Permission General by object_value and object_type.

@return: Object Group Permission General.

@raise ObjectGroupPermissionNotFoundError: Object Group Permission
General not registered.
@raise ObjectGroupPermissionError: Failed to search for the Object
Group Permission General.

@raise OperationalError: Lock wait timeout exceeded.

classmethod ObjectGroupPermission.get_by_pk(id)[source]

” Get Object Group Permission by id.

@return: Object Group Permission.

@raise ObjectGroupPermissionNotFoundError: Object Group Permission
not registered.
@raise ObjectGroupPermissionError: Failed to search for the Object
Group Permission.

@raise OperationalError: Lock wait timeout exceeded.

classmethod ObjectGroupPermission.get_by_unique_key(user_group, object_type, object_value)[source]

“Get Object Group Permission by user_group, object_type and object_value.

@return: Object Group Permission.

@raise ObjectGroupPermissionNotFoundError: Object Group Permission
not registered.
@raise ObjectGroupPermissionError: Failed to search for the Object
Group Permission.

@raise OperationalError: Lock wait timeout exceeded.

ObjectGroupPermission.log = <celery.utils.log.ProcessAwareLogger object at 0x7fdee2f2b590>
ObjectGroupPermission.object_type
ObjectGroupPermission.objects = <networkapi.models.BaseManager.BaseManager object at 0x7fdee2f2b950>
ObjectGroupPermission.update_perms(obj_map, object_value, object_type, user)[source]
ObjectGroupPermission.update_v3(perm)[source]
ObjectGroupPermission.user_group
class networkapi.api_ogp.models.ObjectGroupPermissionGeneral(*args, **kwargs)[source]

Bases: networkapi.models.BaseModel.BaseModel

ObjectGroupPermissionGeneral(id, user_group_id, object_type_id, read, write, change_config, delete)

exception DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

exception ObjectGroupPermissionGeneral.MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

ObjectGroupPermissionGeneral.create_v3(perm)[source]
ObjectGroupPermissionGeneral.delete_v3()[source]
classmethod ObjectGroupPermissionGeneral.get_by_pk(id)[source]

“Get Object Group Permission General by id.

@return: Object Group Permission General.

@raise ObjectGroupPermissionNotFoundError: Object Group Permission
General not registered.
@raise ObjectGroupPermissionError: Failed to search for the Object
Group Permission General.

@raise OperationalError: Lock wait timeout exceeded.

classmethod ObjectGroupPermissionGeneral.get_by_unique_key(user_group, object_type)[source]

“Get Object Group Permission General by user_group and object_type.

@return: Object Group Permission General.

@raise ObjectGroupPermissionNotFoundError: Object Group Permission
General not registered.
@raise ObjectGroupPermissionError: Failed to search for the Object
Group Permission General.

@raise OperationalError: Lock wait timeout exceeded.

ObjectGroupPermissionGeneral.log = <celery.utils.log.ProcessAwareLogger object at 0x7fdee2f2bc50>
ObjectGroupPermissionGeneral.object_type
ObjectGroupPermissionGeneral.objects = <networkapi.models.BaseManager.BaseManager object at 0x7fdee2f2bfd0>
ObjectGroupPermissionGeneral.update_v3(perm)[source]
ObjectGroupPermissionGeneral.user_group
class networkapi.api_ogp.models.ObjectType(*args, **kwargs)[source]

Bases: networkapi.models.BaseModel.BaseModel

ObjectType(id, name)

exception DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

exception ObjectType.MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

classmethod ObjectType.get_by_name(name)[source]

” Get Object Type by name.

@return: Object Type.

@raise ObjectTypeNotFoundError: Object Type not registered. @raise ObjectTypeError: Failed to search for the Object Type. @raise OperationalError: Lock wait timeout exceeded.

classmethod ObjectType.get_by_pk(id)[source]

” Get Object Type by id.

@return: Object Type.

@raise ObjectTypeNotFoundError: Object Type
not registered.
@raise ObjectTypeError: Failed to search for the Object
Type.

@raise OperationalError: Lock wait timeout exceeded.

ObjectType.log = <celery.utils.log.ProcessAwareLogger object at 0x7fdee2f2b110>
ObjectType.objectgrouppermission_set
ObjectType.objectgrouppermissiongeneral_set
ObjectType.objects = <networkapi.models.BaseManager.BaseManager object at 0x7fdee2f2b290>

networkapi.api_ogp.permissions module

networkapi.api_ogp.serializers module

networkapi.api_ogp.urls module

networkapi.api_ogp.views module

Module contents