Interface OsidProxyManager
- All Superinterfaces:
AutoCloseable, 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, LexiconBatchProxyManager, LexiconProxyManager, 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, RegistrationRequestProxyManager, 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, WorkflowEventProxyManager, WorkflowProxyManager, WorkflowRulesProxyManager
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
Modifier and TypeMethodDescriptionvoidchangeBranch(Id branchId, Proxy proxy) Changes the service branch.voidinitialize(OsidRuntimeManager runtime) Initializes this manager.rollbackService(Date rollbackTime, Proxy proxy) Rolls back this service to a point in time.Methods inherited from interface OsidProfile
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordTypeModifier and TypeMethodDescriptionGets this service branch.Gets theBranch Idrepresenting this service branch.Gets a description of this service implementation.Gets a display name for this service implementation.getId()Gets an identifier for this service implementation.Gets the locales supported in this service.Gets the proxy recordTypessupported in this service.Gets the date this service implementation was released.Gets the version of this service implementation.booleanTest for support of a journal branching service.booleanTest for support of a journaling rollback service.booleansupportsOSIDVersion(Version version) Test for support of an OSID specification version.booleansupportsProxyRecordType(Type proxyRecordType) Test for support of a proxy type.Methods inherited from interface OsidProxyManager
closeMethods inherited from interface Sourceable
getBranding, getBrandingIds, getLicense, getProvider, getProviderIdModifier and TypeMethodDescriptionGets a branding, such as an image or logo, expressed using theAssetinterface.Gets the branding assetIds.Gets the terms of usage.Gets theResourcerepresenting the provider.Gets theIdof the provider.
-
Method Details
-
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 configurationIllegalStateException- this manager has already been initialized by theOsidRuntimeNullArgumentException-runtimeisnullOperationFailedException- 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 {@code initialize()} and must set an {@code ILLEGAL_STATE} error.
-
rollbackService
JournalEntry rollbackService(Date rollbackTime, Proxy proxy) throws OperationFailedException, PermissionDeniedException Rolls back this service to a point in time.- Parameters:
rollbackTime- the requested timeproxy- a proxy- Returns:
- the journal entry corresponding to the actual state of this service
- Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure occurredUnimplementedException-supportsJournalRollback()isfalse- 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 branchproxy- a proxy- Throws:
NotFoundException-branchIdnot foundNullArgumentException-branchIdorproxyisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure occurredUnimplementedException-supportsJournalBranching()isfalse- Compliance:
mandatory- This method must be implemented.
-