Package wt.inf.container

Interface WTContainerService

@RemoteInterface public interface WTContainerService


Supported API: true

Extendable: false

  • Method Details

    • changePublicParentDomain

      WTContainer changePublicParentDomain(WTContainer container, AdminDomainRef new_parent) throws WTException
      Changes a WTContainer's publicParentDomain property. The new domain must be included in those returned by getPublicDomains for the container's OrgContainer

      Supported API: true
      Parameters:
      container -
      new_parent -
      Returns:
      WTContainer
      Throws:
      WTException

    • enableProfileGroup

      void enableProfileGroup(WTGroup group) throws WTException


      Supported API: true
      Parameters:
      group -
      Throws:
      WTException

    • create

      WTContainer create(WTContainer container) throws WTException
      Finds an appropriate WTContainerCreator for the given container and calls create().

      Supported API: true
      Parameters:
      container -
      Returns:
      WTContainer
      Throws:
      WTException
      See Also:
      • WTContainerCreator

    • getBasePublicDomain

      AdminDomainRef getBasePublicDomain(OrgContainer container, Class container_class) throws WTException
      Returns the root public domain for containers of the given class. In the OOTB configuration, for products and repositories this will be a domain named "PDM" stored under the container's default domain, and for projects this will be a domain named "Project" stored under the container's default domain.

      Supported API: true
      Parameters:
      container -
      container_class -
      Returns:
      AdminDomainRef
      Throws:
      WTException

    • getByPath

      WTContainerRef getByPath(String path) throws WTException
      Finds a container based on a path. The path is of the form: 
       path                    ::= path_element (path_element)*
 path_element     ::= '/' class_name '=' container_name
 class_name        ::= the fully qualified name of a container class
 container_name :: = the name of a container instance


      Supported API: true
      Parameters:
      path -
      Returns:
      WTContainerRef
      Throws:
      WTException

    • getContainers

      QueryResult getContainers(ContainerSpec spec) throws WTException
      Gets the containers specified in the ContainerSpec.

      Supported API: true
      Parameters:
      spec -
      Returns:
      QueryResult
      Throws:
      WTException
      See Also:

    • getOrgContainer

      OrgContainer getOrgContainer(WTOrganization wt_org) throws WTException
      Find the OrgContainer for a {@link <code>WTOrganization</code>}

      Supported API: true
      Parameters:
      wt_org -
      Returns:
      The associated OrgContainer, or null if one can't be found
      Throws:
      WTException

    • getOrgContainer

      OrgContainer getOrgContainer(WTUser user) throws WTException
      Find the OrgContainer for a {@link <code>WTUser</code>}

      Supported API: true
      Parameters:
      wt_org -
      Returns:
      The associated OrgContainer, or null if one can't be found
      Throws:
      WTException

    • getPublicContextProviders

      DirectoryContextProvider[] getPublicContextProviders(PrincipalSpec spec) throws WTException
      Returns an array of DirectoryContextProviders that provides the capability to select a set of principals for display in clients based on how the PrincipalSpec is configured. The following table presents different results given a combination of container type and principal type configured using a PrincipalSpec

      Notes on this table:

      • By default the includeAllServices property is set to true in the PrincipalSpec used to produce the results in the table below. If it were false, the results would be the same, except only principals from the bundled adapter would be included.
      • By default the performLookup property is set to true in the PrincipalSpec used to produce the results in the table below. So in addition to searching for principals from the current context, it will also searches for principals from ancestor contexts. If it is set to false, the results would only include principals from the current context.
      • If includeOrganizations attribute is set to true when searching for WTGroup, the result will include organizations as well. If its set to false, organizations will be excluded from the results.
      • If the principalClass attribute is WTPrincipal,the resulting array will contain a context or set of contexts for each principal subclass as defined below.
      • Following are the system groups that would be returned by default depending on the context that is being searched. Site : Unrestricted Organizations Organization : Product Creator, Project Creator, Library Creator, All Participating Members, This Org, Filter Template Creator, Shared Team Creator, Product/Project/Library: Team Members, GUEST, INVITED, all roles groups (eg. APPROVER, DESIGNER etc) and all org groups (eg. 435_ORG). Each of these groups can be queried individually by setting the internalGroupSet attribute apppropriately. If performLookup attribute is set to true, then by default all internal groups from the parent context are returned in addition to internal groups from the current context.

      Creates DirectoryContextProviders according to the following specification:

      Container\Principal class type WTOrganization WTGroup/th> WTUser
      ExchangeContainer By default it selects all organizations from all configured adapters. If includeAllServices</code attribute> is set to false, it only selects organizations from the bundled adapter. By default, it selects all Organizations and Site level user defined groups from all configured adapters. It also selects all system group at the Site level. If includeAllServices attribute is set to false, it restricts the Site level user defined groups and Organizations to only the bundled adapter. If includeOrganizations attribute is set to false, organizations wont be returned. By default it selects all users from all configured adapters. if includeAllServices attribute is set to false, it only selects users from the bundled adapter. If filterByOrganization attribute is set to true, it retricts the users to only the ones associated to the Organization of the ExchangeContainer.
      OrgContainer By default it selects all organizations from all configured adapters. If includeAllServices attribute is set to false, it only selects organizations from the bundled adapter. If performLookUp attribute is set to false, it will not return any organizations. By default it selects Site level user defined groups and Organizations from all configured adapters. In addition it also selects user defined groups under the Organization's public node as well as Organization node. It also selects system groups from both the Site and the Org Level. if performLookup attribute is set to false, it does not return any organization. In addition it restricts User defined groups to only the ones under the Organization's public node as well as Organization node. It also restricts the system groups to only the Org Level. If includeOrganizations attribute is set to false, organizations wont be returned. By default it selects all users in all configured adapters. if filterByOrganization attribute is set to true, it selects only users associated to the current OrgContainer. If includeAllServices attribute is set to false, it restricts users to the bundled adapter. If performLookUp attribute is set to false, it will not return any users.
      ContainerTeamManaged By default it selects all organizations from all configured adapters. If includeAllServices attribute is set to false, it only selects organizations from the bundled adapter. If performLookUp attribute is set to false, it will not return any organizations. By default it selects Site level user defined groups and Organizations from all configured adapters. In addition it also selects user defined groups under the OrgContainer's public node as well as Organization node. It also selects system groups from the Site, the Org Level and application context level. if includeOrganizations</code is set to false, it will not return organizations. If performLookUp is set to false it wil only return system groups from the application context level. By default it selects all users in all configured adapters. if filterByOrganization attribute is set to true, it selecst only users associated to the current OrgContainer. If includeAllServices attribute is set to false, it restricts users to the bundled adapter. If performLookUp attribute is set to false, it will not return any users.


      Supported API: true
      Parameters:
      spec -
      Returns:
      DirectoryContextProvider[]
      Throws:
      WTException
      See Also:

    • getPublicDomains

      PublicDomainSet getPublicDomains(OrgContainer container, Class container_class) throws WTException
      Finds all domains that can be used for a child container's publicParentDomain property. This includes the container's base domain for the given container class, as well as all children of the base domain that are also in the container.

      Supported API: true
      Parameters:
      container - OrgContainer whose domains are of interest.
      container_class - Indicates container type (Ex:- Project2.class ) whose base/children domains are looked up.
      Returns:
      PublicDomainSet Set of domain references and domain paths, sorted by domain path for both methods.
      Throws:
      NotAuthorizedException - If the current user does not have access to the domain path (which includes a container path) for the base domain or any of its children.
      WTException

    • makePrivate

      WTContainer makePrivate(WTContainer container) throws WTException
      Sets the container's privateAccess property to true. In addition, reparents the container's defaultDomain to point to the org container's privateDomain.

      Supported API: true
      Parameters:
      container -
      Returns:
      WTContainer
      Throws:
      WTException

    • makePublic

      WTContainer makePublic(WTContainer container) throws WTException
      Sets the container's privateAccess property to false. In addition, reparents the container's defaultDomain to point to the domain stored in the container's publicParentDomain property.

      Supported API: true
      Parameters:
      container -
      Returns:
      WTContainer
      Throws:
      WTException

    • getInternalGroups

      WTPrincipal[] getInternalGroups(PrincipalSpec principalSpec, String pattern) throws WTException


      Supported API: true
      Parameters:
      principalSpec -
      pattern -
      Returns:
      WTPrincipal[]
      Throws:
      WTException

    • createProfileGroup

      boolean createProfileGroup(String name, String description, WTContainer container) throws WTException
      Creates a Standard Profile group with the specified name and residing in the specified container if it does not already exist; otherwise, no Profile group is created and false is returned.

      Supported API: true
      Parameters:
      name -
      description -
      container - Container profile group resides in.
      Returns:
      boolean True if a new profile group was created; otherwise false, usually because a profile group with the specified name already exists for the container.
      Throws:
      WTException

    • getProfileGroup

      WTGroup getProfileGroup(String name, WTContainer container) throws WTException
      Returns the Profile group for the specified name, and residing in the specified container if it exists. Profile type is not considered; the first profile found matching the name and container is returned. If a matching profile does not exist, null is returned.

      Supported API: true
      Parameters:
      name -
      container - Container profile group resides in.
      Returns:
      WTGroup
      Throws:
      WTException

    • getProfileGroup

      WTGroup getProfileGroup(String name, WTContainer container, Profile.Type profileType) throws WTException
      Returns the Profile group of the specified type, with the specified name, and residing in the specified container if it exists. If a matching profile does not exist, null is returned.

      Supported API: true
      Parameters:
      name -
      container - Container profile group resides in.
      profileType - The type of Profile search to for. Possible values are: Profile.Type.STANDARD, Profile.Type.LICENSE, Profile.Type.ANY (any type is searched). If ANY is specified, the first profile matching name and container is returned. If null is specified, it defaults to ANY.
      Returns:
      WTGroup
      Throws:
      WTException

    • getProfileGroups

      Map getProfileGroups(WTContainer container) throws WTException
      Returns all Profile groups residing in the specified container. Profile type is not considered; any profile type is returned.

      Supported API: true
      Parameters:
      container -
      Returns:
      Map
      Throws:
      WTException

    • getProfileGroups

      Map<Boolean,Enumeration<WTPrincipal>> getProfileGroups(WTContainer container, Profile.Type profileType) throws WTException
      Returns all Profile groups of the specified type and residing in the specified container.

      Supported API: true
      Parameters:
      container -
      profileType - The type of Profiles to include in the result map. Possible values are: Profile.Type.STANDARD, Profile.Type.LICENSE, Profile.Type.ANY (any type is returned). If null is specified, it defaults to ANY.
      Returns:
      Map
      Throws:
      WTException

    • getProfileGroupsForUser

      Map getProfileGroupsForUser(WTUser user) throws WTException
      Returns all profile groups that apply to the given user. Profile type is not considered; any profile type is returned.

      Supported API: true
      Parameters:
      user -
      Returns:
      Map
      Throws:
      WTException

    • getProfileGroupsForUser

      Map getProfileGroupsForUser(WTUser user, Profile.Type profileType) throws WTException
      Returns all the profile groups of the specified profile type, that apply to the given user.

      Supported API: true
      Parameters:
      user -
      profileType - The type of Profiles to include in the result map. Possible values are: Profile.Type.STANDARD, Profile.Type.LICENSE, Profile.Type.ANY (any type is returned). If null is specified, it defaults to ANY.
      Returns:
      Map
      Throws:
      WTException

    • getProfileGroupsForRoleAccessCheck

      Map getProfileGroupsForRoleAccessCheck(WTUser user) throws WTException
      Returns all profile groups that apply to the given user. Profile type is not considered; any profile type is returned. The output of this set is intended for evaluating visibility and so overlaps will be eliminated in cases where Org and Site profiles have similar names.

      Supported API: true
      Parameters:
      user -
      Returns:
      Map
      Throws:
      WTException

    • getProfileGroupsForRoleAccessCheck

      Map getProfileGroupsForRoleAccessCheck(WTUser user, Profile.Type profileType) throws WTException
      Returns the profile groups of the specified type that apply to the given user. The output of this set is intended for evaluating visibility and so overlaps will be eliminated in cases where Org and Site profiles have similar names.

      Supported API: true
      Parameters:
      user -
      profileType - The type of Profiles to include in the result map. Possible values are: Profile.Type.STANDARD, Profile.Type.LICENSE, Profile.Type.ANY (any type is returned). If null is specified, it defaults to ANY.
      Returns:
      Map
      Throws:
      WTException

    • updateProfileGroup

      void updateProfileGroup(WTGroup group) throws WTException


      Supported API: true
      Parameters:
      group -
      Throws:
      WTException

    • deleteProfileGroup

      void deleteProfileGroup(WTGroup group) throws WTException


      Supported API: true
      Parameters:
      group -
      Throws:
      WTException

    • disableProfileGroup

      void disableProfileGroup(WTGroup group) throws WTException


      Supported API: true
      Parameters:
      group -
      Throws:
      WTException

    • getInternalGroupType

      String getInternalGroupType(WTGroup internalGroup) throws WTException
      This API is used to get the internal group type for to help in import/export of internal groups.

      Supported API: true
      Parameters:
      internalGroup -
      Returns:
      String
      Throws:
      WTException

    • getProfileGroupType

      String getProfileGroupType(WTGroup profileGroup) throws WTException
      The API returns the type of the profile group. The type could be either enabled or disabled.

      Supported API: true
      Parameters:
      profileGroup -
      Returns:
      String
      Throws:
      WTException

    • getDisplayPath

      String getDisplayPath(WTContainerRef containerRef, Locale locale) throws WTException
      The API returns the display path for a given container in a specified locale.

      Supported API: true
      Parameters:
      WTContainerRef -
      Locale -
      Returns:
      String
      Throws:
      WTException

    • deleteProfileGroups

      void deleteProfileGroups(WTCollection groups) throws WTException
      Deletes multiple profiles

      Supported API: true
      Parameters:
      groups -
      Throws:
      WTException

    • createOrGetProfileGroup

      WTGroup createOrGetProfileGroup(String name, String description, WTContainer container) throws WTException
      Returns the Standard Profile group with the specified name and residing in the specified container if it exists; otherwise, a new Standard Profile group is created.

      Supported API: true
      Parameters:
      name -
      description -
      container - Container profile group resides in.
      Returns:
      WTGroup
      Throws:
      WTException

    • getContainers

      WTContainerRef[] getContainers(LookupSpec ls) throws WTException
      Gets the containers specified in the LookupSpec.

      Supported API: true
      Parameters:
      LookupSpec -
      Returns:
      WTContainerRef[]
      Throws:
      WTException