Class Index

A B C D E F G H I J L M N O P R S T U V W X

A

AbstractAppLinksAdminOnlyServlet Extend this class for servlets that are accessible to users that are able to administrate application links. 
AbstractApplinksServlet Abstract base class for servlets, offering exception handling, template rendering (with automatic web resource inclusion), logging and some convenience methods. 
AbstractApplinksServlet.BadRequestException Used by subclasses to trigger a 400. 
AbstractApplinksServlet.NotFoundException Used by subclasses to trigger a 404. 
AbstractApplinksServlet.RequestException  
AbstractApplinksServlet.UnauthorizedBecauseUnauthenticatedException  
AbstractApplinksServlet.UnauthorizedException Used by subclasses to trigger a 401. 
AbstractAppLinksTypeModuleDescriptor<T>  
AbstractAuthServlet

Base class used by several authentication provider servlets. 

AbstractConsumerServlet All servlets that provide functionality to register another application as a consumer should inherit from this servlet. 
AbstractInternalHostApplication Inherit from this base class when you implement InternalHostApplication
AbstractOAuthConfigServlet  
AbstractResource  
AbstractVelocityContext This Object holds a references to all objects that are used in the velocity templates which list the application links and entity links. 
AddAtlassianServiceProviderServlet When acting as a consumer and using OAuth to authenticate to the service provider, this servlet allows to register another Atlassian application that has the OAuth plugin installed as a service provider. 
AddConsumerByUrlServlet When registering an oauth consumer this servlet allows to register a consumer that is an atlassian application and has the oauth plugin installed. 
AddConsumerManuallyServlet This servlet allows to register an oauth consumer. 
AddConsumerManuallyServlet.FormFields  
AddConsumerReciprocalServlet

This servlet is the counterpart of AddConsumerByUrlServlet and AddConsumerManuallyServlet

AddServiceProviderManuallyServlet

When acting as a consumer and using OAuth to make authenticated request to a service provider this servlet is used to configure outbound OAuth configuration for third-party, non-applinks service provider that don't run our plugin (so we can't just point to their inbound config servlet). 

AdminApplicationLinksInterceptor This interceptor protects rest end point to administrate application links against unauthorized access. 
AdminFilter  
AdminLoginServlet  
AdminUIAuthenticator Component for use in servlet filters and interceptors to limit AppLinks end-point access to administrators. 
AdminUIAuthenticator.SessionHandler  
Anonymous This provider performs no authentication. 
ApplicationId The unique ID of an ApplicationLink
ApplicationIdAdapter  
ApplicationIdUtil  
ApplicationLink Represents a link to a remote application-level entity (JIRA, Confluence, Bamboo, etc). 
ApplicationLinkAddedEvent This event is broadcast after an application link is added and the new primary optionally set. 
ApplicationLinkAuthConfigChangedEvent This event is broadcast after the authentication configuration of an application link has changed. 
ApplicationLinkClient  
ApplicationLinkDeletedEvent This event is broadcast after an application link is deleted and the new primary optionally set. 
ApplicationLinkDetails POJO for holding attributes that may be updated during an ApplicationLink's life-cycle 
ApplicationLinkDetails.Builder  
ApplicationLinkDetailsChangedEvent This event is broadcast after an application link's details (e.g., name or display URL) have changed. 
ApplicationLinkEntity  
ApplicationLinkEvent Base class for events emitted when an ApplicationLink is modified. 
ApplicationLinkInfoEntity  
ApplicationLinkInfoResource This rest end point provides additional information about configured authentication providers and entity links for an Application Link. 
ApplicationLinkListEntity  
ApplicationLinkOfTypeCondition Condition that passes if the context ApplicationLink is of the specified type. 
ApplicationLinkProperties A wrapper around a property set that stores properties for one application link. 
ApplicationLinkProperties.Property  
ApplicationLinkRequest

A request object preconfigured with authentication information for the Application Link it was created for. 

ApplicationLinkRequestAdaptor  
ApplicationLinkRequestFactory Provides authenticated ApplicationLinkRequest objects. 
ApplicationLinkRequestFactoryFactory  
ApplicationLinkRequestFactoryFactoryImpl  
ApplicationLinkRequestFactoryFactoryImpl.AbsoluteURLRequestFactory  
ApplicationLinkRequestFactoryFactoryImpl.AbsoluteURLRequestFactoryWithAdminURI  
ApplicationLinkRequestFactoryFactoryImpl.SalRequestFactoryAdapter  
ApplicationLinkResource  
ApplicationLinkResponseHandler<R> Callback interface used by execute(ApplicationLinkResponseHandler) method. 
ApplicationLinksAdminCondition Condition which checks if the user has the permission to administrate application links. 
ApplicationLinkService Provides methods for retrieving ApplicationLinks representing linked applications (e.g. 
ApplicationLinkServiceFactoryBean Creates a proxy for ApplicationLinkService 
ApplicationLinksExistCondition Condition that passes if at least one ApplicationLink (of the specified type, if supplied) is configured. 
ApplicationLinksIDChangedEvent This event is emitted by the even system when an Application Link's unique ID changed. 
ApplicationLinkState if (peer is OFFLINE) { display "server offline" and "relocate" icon. 
ApplicationLinkStateAdapter  
ApplicationLinkUIService Generates HTML fragments to support a standardized UX for displaying and controlling application link status. 
ApplicationLinkUIService.MessageBuilder An HTML fragment builder returned by authorisationRequest(ApplicationLink)
ApplicationLinkUIService.MessageFormat Constants for use with format(MessageFormat)
ApplicationStatus  
ApplicationType Represents the type of an ApplicationLink
ApplicationTypeModuleDescriptor  
AppLinkPluginUtil  
ApplinksConfigServlet This servlet is available in the RefApp and allows the user to configure RefApp-specific AppLinks properties (such as the application's instance name). 
AppLinksManifestDownloader Non-public component that is used to download manifests for AppLinks peers. 
AppLinksManifestProducer

Abstract base class for all AppLinks manifest producers. 

AtLeastOneLocalEntityIsVisibleCondition Condition that passes if there is at least one local entity visible to the currently logged in user. 
AuthenticationConfigurationException  
AuthenticationConfigurationManager Acts as a data store for authentication providers. 
AuthenticationConfigurationManagerFactoryBean Exposes the AuthenticationConfigurationManager component to the host application. 
AuthenticationConfigurationManagerImpl  
AuthenticationConfigurator This component delegates the configuration of authentication after an application link has been created to an authentication provider that implements AutoConfiguringAuthenticatorProviderPluginModule
AuthenticationDirection Used to identify the direction of invocations between two application when configuring authentication providers. 
AuthenticationProvider Authentication 
AuthenticationProviderModuleDescriptor atlassian-plugin.xml excerpt: <applinks-authentication-provider key="seraphAuthenticator" class="com.atlassian.applinks.core.auth.basic.BasicAuthenticationProviderPluginModule"> </applinks-authentication-provider>  
AuthenticationProviderPluginModule This is the interface that must be implemented by the class that is used in the authentication provider module descriptor. 
AuthenticationResource  
AuthenticationResponseException  
AuthenticationScenario Describes the relationship between two Unified Application Links enabled servers, with respect to authentication 
AuthenticatorAccessor  
AuthenticatorContainerServlet Servlet for generating a collection of iframes targeting inbound/outbound authenticator configuration servlets. 
AuthenticatorContainerServlet.ConfigTab  
AuthorisationAdminURIGenerator Used to generate URIs for users to view or revoke their credentials for an authorised application link. 
AuthorisationURIGenerator Used to generate URIs for users to supply credentials to AuthenticationProviders. 
AuthTestIframeServlet Generates a page that contains an iframe (id "myframe") whose URL points to AuthTestServlet
AuthTestServlet This servlet tests the authorization state of each applink (or a specific applink, if the application type is specified in the request parameter "app"). 
AuthTestServlet.ItemRepresentation  
AutoConfigurationServlet This servlet enables OAuth as an Outgoing and incoming authentication types. 
AutoConfigurationServlet

Posted to by a peer that wants us to establish bidirectional trust. 

AutoConfiguringAuthenticatorProviderPluginModule Authentication provider modules implementing this interface will be exposed to the Create Application Link Wizard, and considered for initialisation during the link creation process. 

B

BadParameterException  
BadParameterExceptionMapper  
BambooApplicationType  
BambooApplicationTypeImpl  
BambooManifestProducer  
BambooProjectEntityType  
BambooProjectEntityTypeImpl  
BasicAuthenticationProvider TODO: Document this class / interface here 
BasicAuthenticationProviderPluginModule  
BasicAuthRequestFactoryImpl atlassian-plugin.xml excerpt: <applinks-authentication-provider class="com.atlassian.applinks.core.auth.basic.BasicAuthRequestFactoryImpl"> </applinks-authentication-provider>  
BasicHTTPAuthRequestFactory<T extends Request<?, ?>> A RequestFactory decorator that applies Basic HTTP Authentication to the Request objects it creates. 
BasicServlet This servlet provides the interface for configuring Seraph authentication for outgoing HTTP requests via AppLinks. 
BatchedJSONi18NBuilderFactory Use the builder created by this component to fetch and aggregate i18n keys and values in one single JSON object. 
BatchedJSONi18NBuilderFactory.BatchedJSONI18nBuilder  
BeforeApplicationLinkDeletedEvent This event is broad casted BEFORE an application link is deleted. 

C

CleanupResource  
ConcurrentExecutor Provides asynchronous execution. 
ConfigurationFormValuesEntity This objects holds the values of the selected form configuration options. 
ConfluenceApplicationType  
ConfluenceApplicationTypeImpl  
ConfluenceManifestProducer  
ConfluenceSpaceEntityType  
ConfluenceSpaceEntityTypeImpl  
ConsumerConfigurationServlet

Servlet to configure Trusted Applications in the role as consumer (a.k.a. 

ConsumerTokenStoreService The ConsumerTokenStoreService is a wrapper around the com.atlassian.oauth.consumer.ConsumerTokenStore and com.atlassian.oauth.consumer.ConsumerService, it takes care of adding / removing / retrieving consumer tokens. 
ContextFilter Servlet filter to allow capturing the HttpServletRequest context for the current thread. 
ContextInterceptor Interceptor to allow capturing the REST context for the current thread. 
CreateApplicationLinkRequestEntity This object is used when creating a new application link using the add application link wizard. 
CreateApplicationLinkUIResource This rest end point handles requests from the add and edit application link form. 
CreatedApplicationLinkEntity  
CredentialsRequiredException

Thrown by createRequest(Request.MethodType, String) when the endpoint requires authentication, but no credentials are available. 

CurrentContext Stores the HttpContext and HttpServletRequest for the currently executing request  

D

DefaultApplicationLink  
DefaultApplicationLinkService  
DefaultApplicationLinkUIService Standard implementation of ApplicationLinkUIService
DefaultAppLinkPluginUtil  
DefaultConsumerTokenStoreService  
DefaultEntityLink  
DefaultEntityLinkBuilderFactory  
DefaultEntityLinkBuilderFactory.DefaultEntityLinkBuilder  
DefaultEntityLinkService  
DefaultEntityReference Default implementation of EntityReference provided as a convenience to facilitate implementation of InternalHostApplication 
DefaultServiceProviderStoreService  
DefaultTypeAccessor  
DefaultWebFragmentHelper  
DelegatingOrphanedTrustDetector Aggregates authentication provider-specific OrphanedTrustDetector implementations 
DescriptorWeightAttributeParser This class contains the logic for reading the weight value from a module descriptor's XML element. 
DocumentationLinker Provides URIs for UAL documentation. 
DocumentationLinkerImpl  

E

EntityLink Represents a link to a remote entity (Project, Space, Repository, etc). 
EntityLinkAddedEvent This event is broadcast after an entity link is added and the new primary optionally set. 
EntityLinkBuilderFactory Factory for providing builders with which to create EntityLinks  
EntityLinkBuilderFactory.EntityLinkBuilder  
EntityLinkClient  
EntityLinkDeletedEvent This event is broadcast after an entity link is deleted and the new primary optionally set. 
EntityLinkEntity  
EntityLinkEvent Base class for events emitted when an EntityLink is modified 
EntityLinkProperties This class is a wrapper around the property set, that stores all properties of an Entity Link. 
EntityLinkResource TODO elements for links? need a method that returns a single link for a specified ltype+lkey+rtype+rkey+appName?  
EntityLinkService

Provides methods for retrieving entities from linked applications that are associated with local entities (e.g. 

EntityLinkServiceFactoryBean Creates a proxy for EntityLinkService 
EntityReference Represents an application "project-level" entity (e.g. 
EntityResource

This service has two responsibilities:

  1. Returning a list of entities local to this instance that are accessible to the logged in user. 
EntityRetriever  
EntityType Represents the type of an EntityLink
EntityTypeEntity  
EntityTypeListEntity  
EntityTypeModuleDescriptor  
EntityUtil  
ErrorListEntity  

F

FishEyeCrucibleApplicationType  
FishEyeCrucibleApplicationTypeImpl  
FishEyeCrucibleHashAuthenticatorPropertiesUpgradeTask Upgrades stored Authentication Provider configuration properties to their new MD5 hashed format (see APL-533 for more context). 
FishEyeCrucibleManifestProducer  
FishEyeCrucibleProjectEntityType  
FishEyeCrucibleProjectEntityTypeImpl  
FishEyeRepositoryEntityType  
FishEyeRepositoryEntityTypeImpl  

G

GenericApplicationType The generic application type supports all "out-of-the-box" authentication types that UAL ships with. 
GenericApplicationTypeImpl The generic application type supports all "out-of-the-box" authentication types that UAL ships with. 
GenericEntityType The generic entity type, can be used in combination with the generic application to create entity links to this arbitrary application. 
GenericEntityTypeImpl  
GenericManifestProducer  

H

HashChangedHandler This class manages the last modified date of a single HTTP resource. 
Holder<T> Generic holder class  
HostApplication Injectable component interface that is implemented by the host application and contains the application specific logic to determine the application's capabilities. 
HostProxyResource  
HtmlSafeContent Used to include strings that must not be escaped into templates. 

I

I18NEntryListEntity  
IconizedIdentifiableType Base class that generates a local icon URL based on the TypeId name of the sub class. 
IdentifiableType  
ImpersonatingAuthenticationProvider Impersonating authentication providers allow to specify a user, on his behalf the request to the remote application is made. 
IncomingTrustAuthenticationProviderPluginModule This interface can be used by AuthentiationProviderPluginModules that can also configure inbound authentication. 
InstanceNameGenerator Implements the Atlassian Name Generation Algorithm(TM) (taking the first character of each part of the hostname -- like JAC for jira.atlassian.com). 
InternalApplicationLink  
InternalEntityLinkService Internal interface for the MutatingEntityLinkService that exposes functionality that is available to applinks-core only. 
InternalHostApplication Injectable component interface that is implemented by the host application and contains the application specific logic to determine the application's capabilities. 
InternalTypeAccessor  
InvalidURLException Indicates that a URL is invalid. 

J

JiraApplicationType  
JiraApplicationTypeImpl Used for both:
  • a UAL-enabled JIRA instance; and
  • a JIRA instance that predates UAL but does has have Trusted Applications support. 
JiraManifestProducer  
JiraProjectEntityType  
JiraProjectEntityTypeImpl Represents a project in a non-UAL JIRA instance. 

L

LinkAndAuthProviderEntity This entity is used for displaying purposes in the list application link screen. 
LinkCreationResponseException  
LinkedEntity Base class for entities. 
LinkEvent A marker interface for all events fired from this plugin 
ListApplicationLinksAction  
ListApplicationLinksContext This class lists all objects which are used in the velocity templates in the list application links screen. 
ListApplicationLinksContext.HTMLSafeJSONArray  
ListApplicationLinksContext.HTMLSafeJSONObject  
ListApplicationLinksContext.UnescapedI18nResolver  
ListApplicationLinksServlet A servlet that renders a velocity template to display all configured linked applications. 
ListApplicationLinksUIResource This rest end point is used when displaying application links. 
ListEntity<T>  
ListEntityLinksAction  
ListEntityLinksContext This class lists all objects that are used in the velocity templates in the list entity links screen. 
ListEntityLinksContext.ApplicationOption  
ListEntityLinksServlet A servlet that renders a velocity template to display all configured entity links. 

M

Manifest Describes the capabilities of a remote application. 
ManifestEntity  
ManifestNotFoundException  
ManifestProducer Each application type implements and registers its own manifest retriever component. 
ManifestResource  
ManifestRetriever  
ManifestRetrieverDispatcher Simple component for retrieving manifests from remote applications. 
ManifestRetrieverFactoryBean Creates a proxy for ManifestRetriever 
Message  
MessageFactory  
MutableApplicationLink Interface adding mutating behaviour for ApplicationLinks 
MutatingApplicationLinkService This interface adds methods for adding, updating and deleting ApplicationLinks. 
MutatingEntityLinkService  

N

NonAppLinksApplicationType This SPI interface allows additional ApplicationTypes to be registered via the administrative UI and made available to consumers via the various applinks services. 
NonAppLinksEntityType This SPI interface allows additional EntityTypes to be registered via the administrative UI and made available to consumers via the various applinks services. 
NonImpersonatingAuthenticationProvider TODO: Document this class / interface here 
NotAdministratorException  

O

OAuthApplinksResponseHandler<R>  
OAuthApplinksServlet This servlet 'manages' the OAuth dance, consisting of the following steps: 1) Obtain a request token from the remote application 2) Redirect the user to the remote application and ask for authorization 3) Wait for the redirect by the remote application and swap the request token for an access token afterwards 4) Notify the user that authorization was successfully and he can continue with his operation. 
OAuthAuthenticationProvider The OAuth Authentication provider indicating that OAuth is used to authenticate to the remote application. 
OAuthAuthenticatorProviderPluginModule The OAuthAuthenticatorProviderPluginModule returns a OAuthRequestFactoryImpl to make authenticated requests using OAuth and also contains the logic to determine the correct URL for the configuration UI. 
OAuthConfigListener This event listener listens to the BeforeApplicationLinkDeletedEvent event and clears other oauth configuration stores when an application link gets deleted. 
OAuthHelper A helper class that detects, if the remote application has the Atlassian OAuth plugin installed and can also fetch the consumer information from this application. 
OAuthOrphanedTrustDetector Finds orphaned OAuth consumers (that is, they are stored locally but are not related to a configured ApplicationLink
OAuthPermissionDeniedException Thrown when a user refuses to permit an OAuth consumer to access protected resources. 
OAuthRequest  
OAuthRequestFactoryImpl * atlassian-plugin.xml excerpt: {@code  
OAuthTestRedirectServlet This servlet test that you can make a request using oauth to a resource that redirects and you get the redirected response. 
OAuthTokenRetriever  
OptionalURIAdapter Adaptor that permits null values. 
OrphanedTrust  
OrphanedTrustCertificate POJO for identifying an orphaned trust relationship 
OrphanedTrustCertificate.Type  
OrphanedTrustDetector Components implementing this interface retrieve a list of 'orphaned' trust certificates (that is, they are stored locally but are not related to a configured ApplicationLink
OrphanedTrustEntityList  
OrphanedTrustResource Provides REST access and initialisation of OAuth and Trusted Applications certs  
OrphanedTrustResource REST resource for handling operations on OrphanedTrustCertificate
OsgiServiceProxyFactory Creates a proxy for an osgi service that is able to link to different implementations at runtime. 
OsgiServiceProxyFactory.ServiceTimeoutExceeded Thrown if the timeout waiting for the service has been exceeded  
OsgiServiceProxyFactory.ServiceTrackerFactory Abstracts how service trackers are created, mostly for testing  

P

PermissionCode Enumeration of possible responses from permission checking resources. 
PermissionCodeAdapter  
PermissionCodeEntity  
PermissionResource  
PropertiesRequestEntity  
PropertiesResource Rest resource for integration testing. 
PropertyService  
PropertySet Provides access to settings. 
ProviderConfigurationServlet

Servlet to configure Trusted Applications in the role as provider (a.k.a. 

R

ReciprocalActionException Thrown when a reciprocal action, such as the deletion or creation of a link, fails in a remote application 
RedirectedServlet The RedirectsToSomewhereServlet will throw a redirect to this servlet. 
RedirectsToSomewhereServlet Test class to test, if OAuth can handle redirects. 
RefAppApplicationType  
RefAppApplicationTypeImpl  
RefAppCharlieEntityType  
RefAppCharlieEntityTypeImpl  
RefAppInternalHostApplication The refapp does not support the concept of an "instance name", so our application-specific modules include an admin page that allows the user to specify a unique name for its instance. 
RefAppManifestProducer  
ReferenceEntityList  
ReferenceEntityList.ReferenceEntity  
RelocateApplicationLinkUIResource Modifies an application link's RPC URL. 
RemoteErrorListException  
RendererContextBuilder  
RequestUtil  
RequiredBaseURIAdapter Adapter that does not permit null values and ensures that URI does not end with slashes. 
RequiredURIAdapter Adaptor that does not permit null values. 
ResourceUrlHandler  
ResponseInfoEntity  
RestEntityLinkList  
RestUtil  

S

SalPropertyService Default PropertyService implementation that delegates to SAL

NOTE - this implementation means that all SalPropertySets are backed by the same global PluginSettings object. 
SalPropertySet Default PropertySet implementation that delegates to SAL  
ServiceProviderStoreService This is a wrapper around the com.atlassian.oauth.serviceprovider.ServiceProviderConsumerStore and the com.atlassian.oauth.serviceprovider.ServiceProviderTokenStore. 
ServiceProviderUtil Creates service provider URL for a service provider that has the atlassian oauth plugin installed. 
ServletPathConstants  
StaticUrlApplicationType Application types can implement this interface if there is only ever one URL that they will point at. 
SubversionApplicationType  
SubversionManifestProducer  
SubversionPathEntityType  
SubvertedEntityLinkService Provides methods to bypass permission checking when retrieving entity links. 
SupportedInboundAuthenticationModuleDescriptor

Marker module for supported incoming authentication types for the local application. 

T

TrustConfigurator Plugin component used to share the configuration logic between all 3 servlets and the plugin module. 
TrustConfigurator.ConfigurationException  
TrustedApplicationReaper Listens for BeforeApplicationLinkDeletedEvents and removes inbound Trusted Apps configuration when an application link is being removed. 
TrustedAppsAuthenticationProvider Pass this type to the createAuthenticatedRequestFactory(Class) method to obtain a com.atlassian.sal.api.net.RequestFactory instance that uses the Trusted Apps protocol for transparent authentication. 
TrustedAppsAuthenticationProviderPluginModule  
TrustedAppsOrphanedTrustDetector Finds orphaned Trusted Applications certificates (that is, they are stored locally but are not related to a configured ApplicationLink
TwitterApplicationType  
TwitterManifestProducer  
TypeAccessor Provides access to singleton instances of EntityType and ApplicationType and registered AuthenticationProvider classes. 
TypeAccessorServiceFactoryBean Creates a proxy for TypeAccessor
TypeId  
TypeIdAdapter  
TypeNotInstalledException Thrown if the requested ApplicationLink or EntityLink's ApplicationType or EntityType is currently not installed. 
TypeNotInstalledExceptionMapper  
TypeResource  

U

UpgradeApplicationLinkRequestEntity  
UpgradeApplicationLinkResponseEntity Returned by the upgrade methods in UpgradeApplicationLinkUIResource
UpgradeApplicationLinkUIResource  
URIUtil  

V

VelocityContextFactory  
VersionAdapter  

W

WebFragmentContext Provides the rendering context for web fragments displayed by the applinks plugin 
WebFragmentContext.Builder  
WebFragmentHelper Provides rendered web-items and web-panels for display by the applinks plugin  
WebItemEntity  
WebItemEntity.Builder  
WebItemEntityList  
WebPanelEntity  
WebPanelEntityList  
WebResources  
WhoAmIServlet

Returns the username of the current user in plain text in the response body. 

X

XsrfProtectedServlet