Package javax.xml.registry

Interface LifeCycleManager

  • All Known Subinterfaces:
    BusinessLifeCycleManager
    public interface LifeCycleManager
    The LifeCycleManager interface is the main interface in the API for managing life cycle operations on objects defined by the information model.

    The factory methods of this interface must throw an UnsupportedCapabilityException if the client attempts to create an instance of an infomodel interface that is not supported by the capability level of the Jakarta XML Registries provider.

    Author:
    Farrukh S. Najmi

    • Method Detail

      • createObject

        Object createObject​(String interfaceName)
             throws JAXRException,
                    InvalidRequestException,
                    UnsupportedCapabilityException
        Creates instances of information model interfaces (factory method). To create an Organization, use this method as follows: 
         Organization org = (Organization)
    lifeCycleMgr.createObject(LifeCycleManager.ORGANIZATION);
        Capability Level: 0
        Parameters:
        interfaceName - the unqualified name of an interface in the javax.xml.registry.infomodel package
        Returns:
        an Object that can then be cast to an instance of the interface
        Throws:
        JAXRException - if the Jakarta XML Registries provider encounters an internal error
        InvalidRequestException - if the interface is not an interface in the javax.xml.registry.infomodel package
        UnsupportedCapabilityException - if the client attempts to create an instance of an infomodel interface that is not supported by the capability level of the Jakarta XML Registries provider

      • createAssociation

        Association createAssociation​(RegistryObject targetObject,
                              Concept associationType)
                       throws JAXRException
        Creates an Association instance using the specified parameters. The sourceObject is left null and will be set when the Association is added to a RegistryObject.

        Note that for a UDDI provider an Association may only be created between Organizations.

        Capability Level: 0
        Parameters:
        targetObject - the target RegistryObject for the association
        associationType - the association type for the Association
        Returns:
        the Association instance created
        Throws:
        JAXRException - if the Jakarta XML Registries provider encounters an internal error

      • createClassification

        Classification createClassification​(ClassificationScheme scheme,
                                    String name,
                                    String value)
                             throws JAXRException
        Creates a Classification instance for an external Classification using the specified String name and String value that identify a taxonomy element within the specified ClassificationScheme.
        Capability Level: 0
        Parameters:
        scheme - the ClassificationScheme to be used
        name - the name of the taxonomy element (a String)
        value - the value of the taxonomy element
        Returns:
        the Classification instance created
        Throws:
        JAXRException - if the Jakarta XML Registries provider encounters an internal error

      • createClassification

        Classification createClassification​(ClassificationScheme scheme,
                                    InternationalString name,
                                    String value)
                             throws JAXRException
        Creates a Classification instance for an external Classification using the specified InternationalString name and String value that identify a taxonomy element within the specified ClassificationScheme.
        Capability Level: 0
        Parameters:
        scheme - the ClassificationScheme to be used
        name - the name of the taxonomy element (an InternationalString)
        value - the value of the taxonomy element
        Returns:
        the Classification instance created
        Throws:
        JAXRException - if the Jakarta XML Registries provider encounters an internal error

      • createClassification

        Classification createClassification​(Concept concept)
                             throws JAXRException,
                                    InvalidRequestException
        Creates a Classification instance for an internal Classification using the specified Concept that identifies a taxonomy element within an internal ClassificationScheme.
        Capability Level: 0
        Parameters:
        concept - the Concept that identifies the taxonomy element
        Returns:
        the Classification instance created
        Throws:
        JAXRException - if the Jakarta XML Registries provider encounters an internal error
        InvalidRequestException - if the Concept is not under a ClassificationScheme

      • createClassificationScheme

        ClassificationScheme createClassificationScheme​(String name,
                                                String description)
                                         throws JAXRException,
                                                InvalidRequestException
        Creates a ClassificationScheme given the specified String parameters.
        Capability Level: 0
        Parameters:
        name - the name of the ClassificationScheme (a String)
        description - a description of the ClassificationScheme (a String)
        Returns:
        the ClassificationScheme instance created
        Throws:
        JAXRException - if the Jakarta XML Registries provider encounters an internal error
        InvalidRequestException - if the request was invalid

      • createClassificationScheme

        ClassificationScheme createClassificationScheme​(Concept concept)
                                         throws JAXRException,
                                                InvalidRequestException
        Creates a ClassificationScheme from a Concept that has no ClassificationScheme or parent Concept.

        This method is a special-case method to do a type-safe conversion from Concept to ClassificationScheme.

        This method is provided to allow for Concepts returned by the BusinessQueryManager findConcepts call to be safely cast to ClassificationScheme. It is up to the programmer to make sure that the Concept is indeed semantically a ClassificationScheme.

        This method is necessary because in the UDDI specification a tModel may serve multiple purposes, and there is no way to know when a tModel maps to a Concept and when it maps to a ClassificationScheme. The UDDI specification leaves the determination to the programmer, and consequently so does this method.

        Capability Level: 0
        Parameters:
        concept - the Concept to be used
        Returns:
        the ClassificationScheme instance created
        Throws:
        JAXRException - if the Jakarta XML Registries provider encounters an internal error
        InvalidRequestException - if the Concept has a parent Concept or is under a ClassificationScheme

      • createConcept

        Concept createConcept​(RegistryObject parent,
                      String name,
                      String value)
               throws JAXRException
        Creates a Concept instance using the specified parameters, where the name is a String.
        Capability Level: 0
        Parameters:
        parent - a reference either to a parent ClassificationScheme or to a Concept
        name - the name of the concept (a String)
        value - the value of the concept
        Returns:
        the Concept instance created
        Throws:
        JAXRException - if the Jakarta XML Registries provider encounters an internal error

      • createConcept

        Concept createConcept​(RegistryObject parent,
                      InternationalString name,
                      String value)
               throws JAXRException
        Creates a Concept instance using the specified parameters, where the name is an InternationalString.
        Capability Level: 0
        Parameters:
        parent - a reference either to a parent ClassificationScheme or to a Concept
        name - the name of the concept (an InternationalString)
        value - the value of the concept
        Returns:
        the Concept instance created
        Throws:
        JAXRException - if the Jakarta XML Registries provider encounters an internal error

      • createEmailAddress

        EmailAddress createEmailAddress​(String address)
                         throws JAXRException
        Creates an EmailAddress instance using an address as the parameter.
        Capability Level: 0
        Parameters:
        address - the email address
        Returns:
        the EmailAddress instance created
        Throws:
        JAXRException - if the Jakarta XML Registries provider encounters an internal error

      • createEmailAddress

        EmailAddress createEmailAddress​(String address,
                                String type)
                         throws JAXRException
        Creates an EmailAddress instance using both an address and a type as parameters.
        Capability Level: 0
        Parameters:
        address - the email address
        type - the type of the address
        Returns:
        the EmailAddress instance created
        Throws:
        JAXRException - if the Jakarta XML Registries provider encounters an internal error

      • createExternalIdentifier

        ExternalIdentifier createExternalIdentifier​(ClassificationScheme identificationScheme,
                                            String name,
                                            String value)
                                     throws JAXRException
        Creates an ExternalIdentifier instance using the specified parameters, where the name is a String.
        Capability Level: 0
        Parameters:
        identificationScheme - the ClassificationScheme used
        name - the name of the external identifier (a String)
        value - the value of the external identifier
        Returns:
        the ExternalIdentifier instance created
        Throws:
        JAXRException - if the Jakarta XML Registries provider encounters an internal error

      • createExternalIdentifier

        ExternalIdentifier createExternalIdentifier​(ClassificationScheme identificationScheme,
                                            InternationalString name,
                                            String value)
                                     throws JAXRException
        Creates an ExternalIdentifier instance using the specified parameters, where the name is an InternationalString.
        Capability Level: 0
        Parameters:
        identificationScheme - the ClassificationScheme used
        name - the name of the external identifier (an InternationalString)
        value - the value of the external identifier
        Returns:
        the ExternalIdentifier instance created
        Throws:
        JAXRException - if the Jakarta XML Registries provider encounters an internal error

      • createExternalLink

        ExternalLink createExternalLink​(String externalURI,
                                String description)
                         throws JAXRException
        Creates an ExternalLink instance using the specified parameters, where the description is a String.
        Capability Level: 0
        Parameters:
        externalURI - the external URI
        description - a description of the link (a String)
        Returns:
        the ExternalLink instance created
        Throws:
        JAXRException - if the Jakarta XML Registries provider encounters an internal error

      • createExternalLink

        ExternalLink createExternalLink​(String externalURI,
                                InternationalString description)
                         throws JAXRException
        Creates an ExternalLink instance using the specified parameters, where the description is an InternationalString.
        Capability Level: 0
        Parameters:
        externalURI - the external URI
        description - a description of the link (an InternationalString)
        Returns:
        the ExternalLink instance created
        Throws:
        JAXRException - if the Jakarta XML Registries provider encounters an internal error

      • createExtrinsicObject

        ExtrinsicObject createExtrinsicObject​(javax.activation.DataHandler repositoryItem)
                               throws JAXRException
        Creates an ExtrinsicObject instance using the specified parameters.
        Capability Level: 1
        Parameters:
        repositoryItem - the DataHandler for the repository item. Must not be null.
        Returns:
        the ExtrinsicObject instance created
        Throws:
        JAXRException - if the Jakarta XML Registries provider encounters an internal error

      • createInternationalString

        InternationalString createInternationalString()
                                       throws JAXRException
        Creates an empty InternationalString instance.
        Capability Level: 0
        Returns:
        the InternationalString instance created
        Throws:
        JAXRException - if the Jakarta XML Registries provider encounters an internal error

      • createInternationalString

        InternationalString createInternationalString​(String s)
                                       throws JAXRException
        Creates an InternationalString instance using a String parameter and the default Locale.
        Capability Level: 0
        Parameters:
        s - the String from which to create the InternationalString
        Returns:
        the InternationalString instance created
        Throws:
        JAXRException - if the Jakarta XML Registries provider encounters an internal error

      • createInternationalString

        InternationalString createInternationalString​(Locale l,
                                              String s)
                                       throws JAXRException
        Creates an InternationalString instance using the specified Locale and String parameters.
        Capability Level: 0
        Parameters:
        l - the Locale in which to create the InternationalString
        s - the String from which to create the InternationalString
        Returns:
        the InternationalString instance created
        Throws:
        JAXRException - if the Jakarta XML Registries provider encounters an internal error

      • createKey

        Key createKey​(String id)
       throws JAXRException
        Creates a Key instance from an ID.
        Capability Level: 0
        Parameters:
        id - the ID string from which to create the Key
        Returns:
        the Key instance created
        Throws:
        JAXRException - if the Jakarta XML Registries provider encounters an internal error

      • createLocalizedString

        LocalizedString createLocalizedString​(Locale l,
                                      String s)
                               throws JAXRException
        Creates a LocalizedString instance using the specified Locale and String parameters.
        Capability Level: 0
        Parameters:
        l - the Locale in which to create the LocalizedString
        s - the String from which to create the LocalizedString
        Returns:
        the LocalizedString instance created
        Throws:
        JAXRException - if the Jakarta XML Registries provider encounters an internal error

      • createLocalizedString

        LocalizedString createLocalizedString​(Locale l,
                                      String s,
                                      String charSetName)
                               throws JAXRException
        Creates a LocalizedString instance using the specified Locale, String, and character set parameters.
        Capability Level: 0
        Parameters:
        l - the Locale in which to create the LocalizedString
        s - the String from which to create the LocalizedString
        charSetName - the name of the character set to use
        Returns:
        the LocalizedString instance created
        Throws:
        JAXRException - if the Jakarta XML Registries provider encounters an internal error

      • createOrganization

        Organization createOrganization​(String name)
                         throws JAXRException
        Creates an Organization instance using the specified name, where the name is a String.
        Capability Level: 0
        Parameters:
        name - the name of the Organization
        Returns:
        the Organization instance created
        Throws:
        JAXRException - if the Jakarta XML Registries provider encounters an internal error

      • createOrganization

        Organization createOrganization​(InternationalString name)
                         throws JAXRException
        Creates an Organization instance using the specified name, where the name is an InternationalString.
        Capability Level: 0
        Parameters:
        name - the name of the Organization
        Returns:
        the Organization instance created
        Throws:
        JAXRException - if the Jakarta XML Registries provider encounters an internal error

      • createPersonName

        PersonName createPersonName​(String firstName,
                            String middleName,
                            String lastName)
                     throws JAXRException
        Creates a PersonName instance using the specified first, middle, and last names.
        Capability Level: 1
        Parameters:
        firstName - the person's first name
        middleName - the person's middle name
        lastName - the person's last name
        Returns:
        the PersonName instance created
        Throws:
        JAXRException - if the Jakarta XML Registries provider encounters an internal error

      • createPersonName

        PersonName createPersonName​(String fullName)
                     throws JAXRException
        Creates a PersonName instance using the specified full name.
        Capability Level: 0
        Parameters:
        fullName - the person's full name
        Returns:
        the PersonName instance created
        Throws:
        JAXRException - if the Jakarta XML Registries provider encounters an internal error

      • createPostalAddress

        PostalAddress createPostalAddress​(String streetNumber,
                                  String street,
                                  String city,
                                  String stateOrProvince,
                                  String country,
                                  String postalCode,
                                  String type)
                           throws JAXRException
        Creates a PostalAddress instance using the specified parameters.
        Capability Level: 0
        Parameters:
        streetNumber - the street number
        street - the street name
        city - the city name
        stateOrProvince - the state or province name
        country - the country name
        postalCode - the postal code (such as a US ZIP code)
        type - the type of the address
        Returns:
        the PostalAddress instance created
        Throws:
        JAXRException - if the Jakarta XML Registries provider encounters an internal error

      • createRegistryPackage

        RegistryPackage createRegistryPackage​(String name)
                               throws JAXRException
        Creates a RegistryPackage instance using the specified name, where the name is a String.
        Capability Level: 1
        Parameters:
        name - the name of the registry package (a String)
        Returns:
        the RegistryPackage instance created
        Throws:
        JAXRException - if the Jakarta XML Registries provider encounters an internal error

      • createRegistryPackage

        RegistryPackage createRegistryPackage​(InternationalString name)
                               throws JAXRException
        Creates a RegistryPackage instance using the specified name, where the name is an InternationalString.
        Capability Level: 1
        Parameters:
        name - the name of the registry package (an InternationalString)
        Returns:
        the RegistryPackage instance created
        Throws:
        JAXRException - if the Jakarta XML Registries provider encounters an internal error

      • createService

        Service createService​(String name)
               throws JAXRException
        Creates a Service instance using the specified name, where the name is a String.
        Capability Level: 0
        Parameters:
        name - the name of the Service (a String)
        Returns:
        the Service instance created
        Throws:
        JAXRException - if the Jakarta XML Registries provider encounters an internal error

      • createService

        Service createService​(InternationalString name)
               throws JAXRException
        Creates a Service instance using the specified name, where the name is an InternationalString.
        Capability Level: 0
        Parameters:
        name - the name of the Service (an InternationalString)
        Returns:
        the Service instance created
        Throws:
        JAXRException - if the Jakarta XML Registries provider encounters an internal error

      • createServiceBinding

        ServiceBinding createServiceBinding()
                             throws JAXRException
        Creates an empty ServiceBinding instance.
        Capability Level: 0
        Returns:
        the ServiceBinding instance created
        Throws:
        JAXRException - if the Jakarta XML Registries provider encounters an internal error

      • createSlot

        Slot createSlot​(String name,
                String value,
                String slotType)
         throws JAXRException
        Creates a Slot instance using the specified parameters, where the value is a String.
        Capability Level: 0
        Parameters:
        name - the name of the Slot
        value - the value (a String)
        slotType - the slot type
        Returns:
        the Slot instance created
        Throws:
        JAXRException - if the Jakarta XML Registries provider encounters an internal error

      • createSlot

        Slot createSlot​(String name,
                Collection values,
                String slotType)
         throws JAXRException
        Creates a Slot instance using the specified parameters, where the value is a Collection of Strings.
        Capability Level: 0
        Parameters:
        name - the name of the Slot
        values - the value (a Collection of Strings)
        slotType - the slot type
        Returns:
        the Slot instance created
        Throws:
        JAXRException - if the Jakarta XML Registries provider encounters an internal error

      • createSpecificationLink

        SpecificationLink createSpecificationLink()
                                   throws JAXRException
        Creates an empty SpecificationLink instance.
        Capability Level: 0
        Returns:
        the SpecificationLink instance created
        Throws:
        JAXRException - if the Jakarta XML Registries provider encounters an internal error

      • createTelephoneNumber

        TelephoneNumber createTelephoneNumber()
                               throws JAXRException
        Creates an empty TelephoneNumber instance.
        Capability Level: 0
        Returns:
        the TelephoneNumber instance created
        Throws:
        JAXRException - if the Jakarta XML Registries provider encounters an internal error

      • createUser

        User createUser()
         throws JAXRException
        Creates an empty User instance.
        Capability Level: 0
        Returns:
        the User instance created
        Throws:
        JAXRException - if the Jakarta XML Registries provider encounters an internal error

      • saveObjects

        BulkResponse saveObjects​(Collection objects)
                  throws JAXRException
        Saves one or more Objects to the registry. An object may be a RegistryObject subclass instance.

        If an object is not in the registry, it is created in the registry. If it already exists in the registry and has been modified, then its state is updated (replaced) in the registry.

        Capability Level: 0
        Parameters:
        objects - a potentially heterogeneous Collection of RegistryObject instances
        Returns:
        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 Jakarta XML Registries provider encounters an internal error

      • deprecateObjects

        BulkResponse deprecateObjects​(Collection keys)
                       throws JAXRException
        Deprecates one or more previously submitted objects. Deprecation marks an object as "soon to be deleted". Once an object is deprecated, the Jakarta XML Registries provider must not allow any new references (e.g. new Associations, Classifications and ExternalLinks) to that object to be submitted. If a client makes an API call that results in a new reference to a deprecated object, the Jakarta XML Registries provider must throw a java.lang.IllegalStateException within a JAXRException. However, existing references to a deprecated object continue to function normally.
        Capability Level: 1
        Parameters:
        keys - a Collection of keys for the objects to be deprecated
        Returns:
        a BulkResponse containing the Collection of keys for those objects that were deprecated successfully and any JAXRException that was encountered in case of partial commit
        Throws:
        JAXRException - if the Jakarta XML Registries provider encounters an internal error

      • unDeprecateObjects

        BulkResponse unDeprecateObjects​(Collection keys)
                         throws JAXRException
        Undeprecates one or more previously deprecated objects. If an object was not previously deprecated, it is not an error, and no exception is thrown. Once an object is undeprecated, the Jakarta XML Registries provider must again allow new references (e.g. new Associations, Classifications and ExternalLinks) to that object to be submitted.
        Capability Level: 1
        Parameters:
        keys - a Collection of keys for the objects to be undeprecated
        Returns:
        a BulkResponse containing the Collection of keys for those objects that were deprecated successfully and any JAXRException that was encountered in case of partial commit
        Throws:
        JAXRException - if the Jakarta XML Registries provider encounters an internal error

      • deleteObjects

        BulkResponse deleteObjects​(Collection keys)
                    throws JAXRException
        Deletes one or more previously submitted objects from the registry using the object keys.
        Capability Level: 1
        Parameters:
        keys - a Collection of keys for the objects to be deleted
        Returns:
        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 Jakarta XML Registries provider encounters an internal error

      • deleteObjects

        BulkResponse deleteObjects​(Collection keys,
                           String objectType)
                    throws JAXRException
        Deletes one or more previously submitted objects from the registry using the object keys and a specified objectType attribute.
        Capability Level: 0
        Parameters:
        keys - a Collection of keys for the objects to be deleted
        objectType - the objectType attribute for the objects to be deleted
        Returns:
        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 Jakarta XML Registries provider encounters an internal error

      • getRegistryService

        RegistryService getRegistryService()
                            throws JAXRException
        Returns the parent RegistryService that created this object.
        Capability Level: 0
        Returns:
        the parent RegistryService
        Throws:
        JAXRException - if the Jakarta XML Registries provider encounters an internal error
        See Also:
        RegistryService