javax.xml.registry.BusinessLifeCycleManager Maven / Gradle / Ivy
/*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the License). You may not use this file except in
* compliance with the License.
*
* You can obtain a copy of the license at
* https://glassfish.dev.java.net/public/CDDLv1.0.html or
* glassfish/bootstrap/legal/CDDLv1.0.txt.
* See the License for the specific language governing
* permissions and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* Header Notice in each file and include the License file
* at glassfish/bootstrap/legal/CDDLv1.0.txt.
* If applicable, add the following below the CDDL Header,
* with the fields enclosed by brackets [] replaced by
* you own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* Copyright 2007 Sun Microsystems, Inc. All rights reserved.
*/
package javax.xml.registry;
import java.util.*;
import javax.xml.registry.infomodel.*;
/**
* The BusinessLifeCycleManager interface, which is exposed by the Registry Service, implements the
* life cycle management functionality of the Registry as part of a business level API.
* Note that there is no authentication information provided, because the
* Connection interface keeps that state and context on behalf of the client.
*
* @see LifeCycleManager
* @author Farrukh S. Najmi
*/
public interface BusinessLifeCycleManager extends LifeCycleManager {
/**
* Saves the specified Organizations.
* If the object is not in the registry, it is created in the registry.
* If it already exists in the registry and has been modified, its
* state is updated (replaced) in the registry.
*
*
Partial commits are allowed. Processing stops on first SaveException encountered.
*
*
- Capability Level: 0
*
* @param organizations the Collection of Organization objects to be saved
*
* @return a BulkResponse containing the Collection of keys for those objects that were
* saved successfully and any SaveException that was encountered in case of partial commit
*
* @throws JAXRException if the JAXR provider encounters an internal error
*/
BulkResponse saveOrganizations(Collection organizations) throws JAXRException;
/**
* Saves the specified Services.
* If the object is not in the registry, it is created in the registry.
* If it already exists in the registry and has been modified, its
* state is updated (replaced) in the registry.
*
*
Partial commits are allowed. Processing stops on first SaveException encountered.
*
*
- Capability Level: 0
*
* @param services the Collection of Service objects to be saved
*
* @return a BulkResponse containing the Collection of keys for those objects that were
* saved successfully and any SaveException that was encountered in case of partial commit
*
* @throws JAXRException if the JAXR provider encounters an internal error
*/
BulkResponse saveServices(Collection services) throws JAXRException;
/**
* Saves the specified ServiceBindings.
* If the object is not in the registry, it is created in the registry.
* If it already exists in the registry and has been modified, its
* state is updated (replaced) in the registry.
*
*
Partial commits are allowed. Processing stops on first SaveException encountered.
*
*
*
- Capability Level: 0
*
* @param bindings the Collection of ServiceBinding objects to be saved
*
* @return a BulkResponse containing the Collection of keys for those objects that were
* saved successfully and any SaveException that was encountered in case of partial commit
*
* @throws JAXRException if the JAXR provider encounters an internal error
*/
BulkResponse saveServiceBindings(Collection bindings) throws JAXRException;
/**
* Saves the specified Concepts.
* If the object is not in the registry, it is created in the registry.
* If it already exists in the registry and has been modified, its
* state is updated (replaced) in the registry.
*
*
Partial commits are allowed. Processing stops on first SaveException encountered.
*
*
*
- Capability Level: 0
*
* @param concepts the Collection of Concept objects to be saved
*
* @return a BulkResponse containing the Collection of keys for those objects that were
* saved successfully and any SaveException that was encountered in case of partial commit
*
* @throws JAXRException if the JAXR provider encounters an internal error
*/
BulkResponse saveConcepts(Collection concepts) throws JAXRException;
/**
* Saves the specified ClassificationScheme instances.
* If the object is not in the registry, it is created in the registry.
* If it already exists in the registry and has been modified, its
* state is updated (replaced) in the registry.
*
*
Partial commits are allowed. Processing stops on first SaveException encountered.
*
*
*
- Capability Level: 0
*
* @param schemes the Collection of ClassificationScheme objects to be saved
*
* @return a BulkResponse containing the Collection of keys for those objects that were
* saved successfully and any SaveException that was encountered in case of partial commit
*
* @throws JAXRException if the JAXR provider encounters an internal error
*/
BulkResponse saveClassificationSchemes(Collection schemes) throws JAXRException;
/**
* Saves the specified Association instances.
* If the object is not in the registry, it is created in the registry.
* If it already exists in the registry and has been modified, its
* state is updated (replaced) in the registry.
*
*
Partial commits are allowed. Processing stops on first SaveException encountered.
*
*
*
- Capability Level: 0
*
* @param associations the Collection of Association objects to be saved
* @param replace If set to true, the specified associations replace any existing associations
* owned by the caller. If set to false, the specified associations are saved, while
* any existing associations not being updated by this call are preserved.
*
* @return a BulkResponse containing the Collection of keys for those objects that were
* saved successfully and any SaveException that was encountered in case of partial commit
*
* @throws JAXRException if the JAXR provider encounters an internal error
*/
BulkResponse saveAssociations(Collection associations, boolean replace) throws JAXRException;
/**
* Deletes the organizations corresponding to the specified Keys.
* Partial commits are allowed. Processing stops on first DeleteException encountered.
*
*
*
- Capability Level: 0
*
* @param organizationKeys the Collection of keys for the Organization objects to be deleted
*
* @return a BulkResponse containing the Collection of keys for those objects that were
* deleted successfully and any DeleteException that was encountered in case of partial commit
*
* @throws JAXRException if the JAXR provider encounters an internal error
*/
BulkResponse deleteOrganizations(Collection organizationKeys) throws JAXRException;
/**
* Deletes the services corresponding to the specified Keys.
* Partial commits are allowed. Processing stops on first DeleteException encountered.
*
*
*
- Capability Level: 0
*
* @param serviceKeys the Collection of keys for the Service objects to be deleted
*
* @return a BulkResponse containing the Collection of keys for those objects that were
* deleted successfully and any DeleteException that was encountered in case of partial commit
*
* @throws JAXRException if the JAXR provider encounters an internal error
*/
BulkResponse deleteServices(Collection serviceKeys) throws JAXRException;
/**
* Deletes the ServiceBindings corresponding to the specified Keys.
* Partial commits are allowed. Processing stops on first DeleteException encountered.
*
*
*
- Capability Level: 0
*
* @param bindingKeys the Collection of keys for the ServiceBinding objects to be deleted
*
* @return a BulkResponse containing the Collection of keys for those objects that were
* deleted successfully and any DeleteException that was encountered in case of partial commit
*
* @throws JAXRException if the JAXR provider encounters an internal error
*/
BulkResponse deleteServiceBindings(Collection bindingKeys) throws JAXRException;
/**
* Deletes the Concepts corresponding to the specified Keys.
* Partial commits are allowed. Processing stops on first DeleteException encountered.
*
*
*
- Capability Level: 0
*
* @param conceptKeys the Collection of keys for the Concept objects to be deleted
*
* @return a BulkResponse containing the Collection of keys for those objects that were
* deleted successfully and any DeleteException that was encountered in case of partial commit
*
* @throws JAXRException if the JAXR provider encounters an internal error
*/
BulkResponse deleteConcepts(Collection conceptKeys) throws JAXRException;
/**
* Deletes the ClassificationSchemes corresponding to the specified Keys.
* Partial commits are allowed. Processing stops on first DeleteException encountered.
*
*
*
- Capability Level: 0
*
* @param schemeKeys the Collection of keys for the ClassificationScheme objects to be deleted
*
* @return a BulkResponse containing the Collection of keys for those objects that were
* deleted successfully and any DeleteException that was encountered in case of partial commit
*
* @throws JAXRException if the JAXR provider encounters an internal error
*/
BulkResponse deleteClassificationSchemes(Collection schemeKeys) throws JAXRException;
/**
* Deletes the Associations corresponding to the specified Keys.
* Partial commits are allowed. Processing stops on first DeleteException encountered.
*
*
*
- Capability Level: 0
*
* @param associationKeys the Collection of keys for the Association objects to be deleted
*
* @return a BulkResponse containing the Collection of keys for those objects that were
* deleted successfully and any DeleteException that was encountered in case of partial commit
*
* @throws JAXRException if the JAXR provider encounters an internal error
*/
BulkResponse deleteAssociations(Collection associationKeys) throws JAXRException;
/**
* Confirms this Association by the User associated with the caller.
* The User must be the owner of the sourceObject or the targetObject
* in this association.
*
*
* - If the Association is intramural, this method does nothing and returns.
* - If the Association is extramural and already confirmed (isConfirmed returns true), this method does nothing and returns.
* - If the Association is extramural and not already confirmed, this method
* confirms the association for the User associated with the caller.
*
*
* The details of confirming an extramural Association are registry-specific. For UDDI and ebXML registries,
* the registry-specific details are described in the JAXR specification.
*
*
*
- Capability Level: 0
*
* @param assoc the Association object to be confirmed
*
* @throws JAXRException if the JAXR provider encounters an internal error
* @throws InvalidRequestException if the User is not the owner of the
* sourceObject or the targetObject
*/
public void confirmAssociation(Association assoc) throws JAXRException, InvalidRequestException;
/**
* Undoes a previous confirmation of this Association by the User associated with the caller.
* The User must be the owner of the sourceObject or the targetObject
* in this association.
*
*
*
* - If the Association is intramural, this method does nothing and returns.
* - If the Association is extramural and already confirmed (isConfirmed returns true), this method unconfirms it for the requestor.
* - If the Association is extramural and not already confirmed, this method does nothing and returns.
*
*
* The details of unconfirming an extramural Association are registry-specific. For UDDI and ebXML registries,
* the registry-specific details are described in the JAXR specification.
*
*
*
- Capability Level: 0
*
* @param assoc the Association object to be unconfirmed
*
* @throws JAXRException if the JAXR provider encounters an internal error
* @throws InvalidRequestException if the User is not the owner of the
* sourceObject or the targetObject
*/
public void unConfirmAssociation(Association assoc) throws JAXRException, InvalidRequestException;
}