public interface BrokerProcessorAdminSession extends OsidSession
This session creates and removes broker processors. The data for create
and update is provided via the BrokerProcessorForm.
Modifier and Type | Method and Description |
---|---|
void |
aliasBrokerProcessor(Id brokerProcessorId,
Id aliasId)
Adds an
Id to a BrokerProcessor for the
purpose of creating compatibility. |
boolean |
canCreateBrokerProcessor()
Tests if this user can create broker processors.
|
boolean |
canCreateBrokerProcessorWithRecordTypes(Type[] brokerProcessorRecordTypes)
Tests if this user can create a single
BrokerProcessor
using the desired record types. |
boolean |
canDeleteBrokerProcessors()
Tests if this user can delete broker processors.
|
boolean |
canManageBrokerProcessorAliases()
Tests if this user can manage
Id aliases for broker
processors. |
boolean |
canUpdateBrokerProcessors()
Tests if this user can update broker processors.
|
BrokerProcessor |
createBrokerProcessor(BrokerProcessorForm brokerProcessorForm)
Creates a new
BrokerProcessor. |
void |
deleteBrokerProcessor(Id brokerProcessorId)
Deletes a
BrokerProcessor. |
BrokerProcessorForm |
getBrokerProcessorFormForCreate(Type[] brokerProcessorRecordTypes)
Gets the broker processor form for creating new broker processors.
|
BrokerProcessorForm |
getBrokerProcessorFormForUpdate(Id brokerProcessorId)
Gets the broker processor form for updating an existing broker
processor.
|
Distributor |
getDistributor()
Gets the
Distributor associated with this session. |
Id |
getDistributorId()
Gets the
Distributor Id associated with
this session. |
void |
updateBrokerProcessor(BrokerProcessorForm brokerProcessorForm)
Updates an existing broker processor.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getDistributorId()
Distributor
Id
associated with
this session. Distributor Id
associated with this sessionmandatory
- This method must be implemented. Distributor getDistributor() throws OperationFailedException, PermissionDeniedException
Distributor
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canCreateBrokerProcessor()
BrokerProcessor
will result
in a PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer create operations to an
unauthorized user. false
if BrokerProcessor
creation is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canCreateBrokerProcessorWithRecordTypes(Type[] brokerProcessorRecordTypes)
BrokerProcessor
using the desired record types. While
ProvisioningRulesManager.getBrokerProcessorRecordTypes()
can
be used to examine which records are supported, this method tests
which record(s) are required for creating a specific
BrokerProcessor.
Providing an empty array tests if a
BrokerProcessor
can be created with no records.brokerProcessorRecordTypes
- array of broker processor record
types true
if BrokerProcessor
creation
using the specified record Types
is supported,
false
otherwiseNullArgumentException
-
brokerProcessorRecordTypes
is null
mandatory
- This method must be implemented. BrokerProcessorForm getBrokerProcessorFormForCreate(Type[] brokerProcessorRecordTypes) throws OperationFailedException, PermissionDeniedException
brokerProcessorRecordTypes
- array of broker processor record
typesNullArgumentException
-
brokerProcessorRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to get form for requested
record typesmandatory
- This method must be implemented. BrokerProcessor createBrokerProcessor(BrokerProcessorForm brokerProcessorForm) throws OperationFailedException, PermissionDeniedException
BrokerProcessor.
brokerProcessorForm
- the form for this BrokerProcessor
BrokerProcessor
IllegalStateException
- brokerProcessorForm
already used in a create transactionInvalidArgumentException
- one or more of the form
elements is invalidNullArgumentException
- brokerProcessorForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- brokerProcessorForm
did not originate from
getBrokerProcessorFormForCreate()
mandatory
- This method must be implemented. boolean canUpdateBrokerProcessors()
BrokerProcessor
will result
in a PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer update operations to an
unauthorized user. false
if BrokerProcessor
modification is not authorized, true
otherwisemandatory
- This method must be implemented. BrokerProcessorForm getBrokerProcessorFormForUpdate(Id brokerProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
brokerProcessorId
- the Id
of the
BrokerProcessor
NotFoundException
- brokerProcessorId
is
not foundNullArgumentException
- brokerProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void updateBrokerProcessor(BrokerProcessorForm brokerProcessorForm) throws OperationFailedException, PermissionDeniedException
brokerProcessorForm
- the form containing the elements to be
updatedIllegalStateException
- brokerProcessorForm
already used in an update transactionInvalidArgumentException
- the form contains an invalid
valueNullArgumentException
- brokerProcessorForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- brokerProcessorForm
did not originate from
getBrokerProcessorFormForUpdate()
mandatory
- This method must be implemented. boolean canDeleteBrokerProcessors()
BrokerProcessor
will result
in a PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer delete operations to an
unauthorized user. false
if BrokerProcessor
deletion is not authorized, true
otherwisemandatory
- This method must be implemented. void deleteBrokerProcessor(Id brokerProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
BrokerProcessor.
brokerProcessorId
- the Id
of the
BrokerProcessor
to removeNotFoundException
- brokerProcessorId
not foundNullArgumentException
- brokerProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageBrokerProcessorAliases()
Id
aliases for broker
processors. A return of true does not guarantee successful
authorization. A return of false indicates that it is known changing
an alias will result in a PERMISSION_DENIED.
This is
intended as a hint to an application that may opt not to offer alias
operations to an unauthorized user. false
if BrokerProcessor
aliasing is not authorized, true
otherwisemandatory
- This method must be implemented. void aliasBrokerProcessor(Id brokerProcessorId, Id aliasId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Id
to a BrokerProcessor
for the
purpose of creating compatibility. The primary Id
of
the BrokerProcessor
is determined by the provider. The
new Id
performs as an alias to the primary Id
. If the alias is a pointer to another broker processor. it is
reassigned to the given broker processor Id.
brokerProcessorId
- the Id
of a
BrokerProcessor
aliasId
- the alias Id
AlreadyExistsException
- aliasId
is
already assignedNotFoundException
- brokerProcessorId
not foundNullArgumentException
- brokerProcessorId
or aliasId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.