public interface InternalHostApplication extends HostApplication
| Modifier and Type | Method and Description |
|---|---|
boolean |
canManageEntityLinksFor(EntityReference entityReference) |
boolean |
doesEntityExist(String key,
Class<? extends EntityType> type) |
boolean |
doesEntityExistNoPermissionCheck(String key,
Class<? extends EntityType> type) |
URI |
getDocumentationBaseUrl() |
Iterable<EntityReference> |
getLocalEntities() |
String |
getName() |
Iterable<Class<? extends AuthenticationProvider>> |
getSupportedInboundAuthenticationTypes() |
Iterable<Class<? extends AuthenticationProvider>> |
getSupportedOutboundAuthenticationTypes() |
ApplicationType |
getType() |
boolean |
hasPublicSignup() |
EntityReference |
toEntityReference(Object domainObject) |
EntityReference |
toEntityReference(String key,
Class<? extends EntityType> type) |
getBaseUrl, getIdURI getDocumentationBaseUrl()
String getName()
InstanceNameGenerator to
generate a name from the application's base URL.ApplicationType getType()
ApplicationType for this application instance. Implementations should delegate to the
TypeAccessor to resolve an instance of the desired type.Iterable<Class<? extends AuthenticationProvider>> getSupportedInboundAuthenticationTypes()
Iterable of AuthenticationProvider classes enumerating the inbound
authentication methods supported by this application (used to authenticate requests made to this application
instance).Iterable<Class<? extends AuthenticationProvider>> getSupportedOutboundAuthenticationTypes()
Iterable of AuthenticationProvider classes enumerating the outbound
authentication methods supported by this application (used to authenticate requests made by this application
instance to remote applications).Iterable<EntityReference> getLocalEntities()
Iterable containing an EntityReference for every entity in the local instance visible
to the currently logged in user. Note, the implementation must perform a permission check and
return only entities visible the context user (who may be anonymous).boolean doesEntityExist(String key, Class<? extends EntityType> type)
key - the key of an entity local to this application (e.g. JRA, CONF)type - the class of the EntityType of the entity (e.g. JiraProjectEntityType)doesEntityExistNoPermissionCheck(String, Class).boolean doesEntityExistNoPermissionCheck(String key, Class<? extends EntityType> type)
key - the key of an entity local to this application (e.g. JRA, CONF)type - the class of the EntityType of the entity (e.g. JiraProjectEntityType)doesEntityExist(String, Class).EntityReference toEntityReference(Object domainObject)
domainObject - an entity domain object from the application's API (e.g. com.atlassian.jira.project.Project,
com.atlassian.confluence.spaces.Space). Implementations are free to choose which objects supported by this class,
but the complete list should be maintained on the EntityLinkService javadoc.EntityReference initialised with the key and type of the supplied domain object. This method
need not perform any permission checking. Implementations should delegate to the TypeAccessor to
resolve an instance of the desired EntityType.EntityReference toEntityReference(String key, Class<? extends EntityType> type)
key - the key of a local entity (e.g. "JRA", "FECRUDEV", "CR-BAM")type - the class of the EntityType of the entity (e.g. JiraProjectEntityType)EntityReference initialised with the key and type of the supplied domain object. This method
need not perform any permission checking. Implementations should delegate to the TypeAccessor to
resolve an instance of the specified EntityType.boolean canManageEntityLinksFor(EntityReference entityReference)
entityReference - an EntityReference representing an entity contained in the local application
instance.true if the current user has permission to link or unlink the specified EntityReference
to other entities, false otherwise. Typically this method will return true if the current user is a
global administrator, or a 'project administrator' for the specified entity.boolean hasPublicSignup()
true if the host application allows public signup,
false otherwise.Copyright © 2018 Atlassian. All rights reserved.