org.osid

Interface OsidProxyManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidProfile, OsidProxyManager, Sourceable

All Known Subinterfaces:

AcknowledgementBatchProxyManager, AcknowledgementProxyManager, AssessmentAuthoringProxyManager, AssessmentBatchProxyManager, AssessmentProxyManager, AuthenticationBatchProxyManager, AuthenticationKeysBatchProxyManager, AuthenticationKeysProxyManager, AuthenticationProcessProxyManager, AuthenticationProxyManager, AuthorizationBatchProxyManager, AuthorizationProxyManager, AuthorizationRulesProxyManager, BiddingBatchProxyManager, BiddingProxyManager, BiddingRulesProxyManager, BillingBatchProxyManager, BillingPaymentBatchProxyManager, BillingPaymentProxyManager, BillingProxyManager, BloggingBatchProxyManager, BloggingProxyManager, CalendaringBatchProxyManager, CalendaringCycleBatchProxyManager, CalendaringCycleProxyManager, CalendaringProxyManager, CalendaringRulesProxyManager, CatalogingProxyManager, CatalogingRulesProxyManager, ChecklistBatchProxyManager, ChecklistMasonProxyManager, ChecklistProxyManager, CommentingBatchProxyManager, CommentingProxyManager, CommunicationProxyManager, ConfigurationBatchProxyManager, ConfigurationProxyManager, ConfigurationRulesProxyManager, ContactBatchProxyManager, ContactProxyManager, ContactRulesProxyManager, ControlBatchProxyManager, ControlProxyManager, ControlRulesProxyManager, CourseBatchProxyManager, CourseChronicleBatchProxyManager, CourseChronicleProxyManager, CoursePlanProxyManager, CourseProgramBatchProxyManager, CourseProgramProxyManager, CourseProxyManager, CourseRegistrationBatchProxyManager, CourseRegistrationProxyManager, CourseRequisiteProxyManager, CourseSyllabusBatchProxyManager, CourseSyllabusProxyManager, DictionaryBatchProxyManager, DictionaryProxyManager, FilingAllocationProxyManager, FilingProxyManager, FinancialsBatchProxyManager, FinancialsBudgetingBatchProxyManager, FinancialsBudgetingProxyManager, FinancialsPostingBatchProxyManager, FinancialsPostingProxyManager, FinancialsProxyManager, ForumBatchProxyManager, ForumProxyManager, GradingBatchProxyManager, GradingCalculationProxyManager, GradingProxyManager, GradingTransformProxyManager, HierarchyProxyManager, HoldBatchProxyManager, HoldProxyManager, HoldRulesProxyManager, IdBatchProxyManager, IdProxyManager, InquiryBatchProxyManager, InquiryProxyManager, InquiryRulesProxyManager, InstallationBatchProxyManager, InstallationProxyManager, InventoryBatchProxyManager, InventoryProxyManager, InventoryShipmentBatchProxyManager, InventoryShipmentProxyManager, JournalingBatchProxyManager, JournalingProxyManager, LearningBatchProxyManager, LearningProxyManager, LocaleProxyManager, LoggingBatchProxyManager, LoggingProxyManager, MappingBatchProxyManager, MappingPathBatchProxyManager, MappingPathProxyManager, MappingPathRulesProxyManager, MappingProxyManager, MappingRouteProxyManager, MessagingBatchProxyManager, MessagingProxyManager, MeteringBatchProxyManager, MeteringProxyManager, OfferingBatchProxyManager, OfferingProxyManager, OfferingRulesProxyManager, OntologyBatchProxyManager, OntologyProxyManager, OntologyRulesProxyManager, OrderingBatchProxyManager, OrderingProxyManager, OrderingRulesProxyManager, PersonnelBatchProxyManager, PersonnelProxyManager, ProcessProxyManager, ProfileBatchProxyManager, ProfileProxyManager, ProfileRulesProxyManager, ProvisioningBatchProxyManager, ProvisioningProxyManager, ProvisioningRulesProxyManager, ProxyProxyManager, RecipeBatchProxyManager, RecipeProxyManager, RecognitionBatchProxyManager, RecognitionProxyManager, RelationshipBatchProxyManager, RelationshipProxyManager, RelationshipRulesProxyManager, RepositoryBatchProxyManager, RepositoryProxyManager, RepositoryRulesProxyManager, ResourceBatchProxyManager, ResourceDemographicProxyManager, ResourceProxyManager, ResourcingBatchProxyManager, ResourcingProxyManager, ResourcingRulesProxyManager, RoomBatchProxyManager, RoomConstructionBatchProxyManager, RoomConstructionProxyManager, RoomProxyManager, RoomSquattingBatchProxyManager, RoomSquattingProxyManager, RulesCheckProxyManager, RulesProxyManager, SearchProxyManager, SequencingProxyManager, SubscriptionBatchProxyManager, SubscriptionProxyManager, SubscriptionRulesProxyManager, TopologyBatchProxyManager, TopologyPathProxyManager, TopologyProxyManager, TopologyRulesProxyManager, TrackingBatchProxyManager, TrackingProxyManager, TrackingRulesProxyManager, TransactionProxyManager, TransportProxyManager, TypeProxyManager, VotingBatchProxyManager, VotingProxyManager, VotingRulesProxyManager, WorkflowBatchProxyManager, WorkflowProxyManager, WorkflowRulesProxyManager

public interface OsidProxyManager
extends OsidProfile, OsidProxyManager, java.io.Closeable

The OsidProxyManager is the top level interface for all OSID proxy managers. A proxy manager accepts parameters to pass through end-user authentication credentials and other necessary request parameters in a server environment. Native applications should use an OsidManager to maintain a higher degree of interoperability by avoiding this coupling.

An OSID proxy manager is instantiated through the OsidRuntimeManager and represents an instance of a service. An OSID manager is responsible for defining clusters of interoperability within a service and creating sessions that generally correspond to these clusters, An application need only create a single OsidProxyManager per service and implementors must ensure the OsidProxyManager is thread-safe . The OsidSessions spawned from an OSID manager are dedicated to single processing threads. The OsidProxyManager defines methods in common throughout all OSID managers which implement this interface.

Method Summary

Methods

Modifier and Type	Method and Description
void	changeBranch(Id branchId, Proxy proxy) Changes the service branch.
void	initialize(OsidRuntimeManager runtime) Initializes this manager.
JournalEntry	rollbackService(java.util.Date rollbackTime, Proxy proxy) Rolls back this service to a point in time.

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Methods inherited from interface org.osid.binding.java.OsidProxyManager

close

Methods inherited from interface java.io.Closeable

close

Method Detail

initialize

void initialize(OsidRuntimeManager runtime)
                throws ConfigurationErrorException,
                       OperationFailedException

Initializes this manager. A manager is initialized once at the time of creation.

Parameters:

runtime - the runtime environment

Throws:

ConfigurationErrorException - an error with implementation configuration

IllegalStateException - this manager has already been initialized by the OsidRuntime

NullArgumentException - runtime is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

Notes:

In - addition to loading its runtime configuration an implementation may create shared resources such as connection pools to be shared among all sessions of this service and released when this manager is closed. Providers must thread-protect any data stored in the manager. To maximize interoperability, providers should not honor a second call to initialize() and must set an ILLEGAL_STATE error.

rollbackService

JournalEntry rollbackService(java.util.Date rollbackTime,
                           Proxy proxy)
                             throws OperationFailedException,
                                    PermissionDeniedException

Rolls back this service to a point in time.

Parameters:

rollbackTime - the requested time

proxy - a proxy

Returns:

the journal entry corresponding to the actual state of this service

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnimplementedException - supportsJournalRollback() is false

Compliance:

mandatory - This method must be implemented.

changeBranch

void changeBranch(Id branchId,
                Proxy proxy)
                  throws NotFoundException,
                         OperationFailedException,
                         PermissionDeniedException

Changes the service branch.

Parameters:

branchId - the new service branch

proxy - a proxy

Throws:

NotFoundException - branchId not found

NullArgumentException - branchId or proxy is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnimplementedException - supportsJournalBranching() is false

Compliance:

mandatory - This method must be implemented.