Application link not working due to "ManifestNotFoundException"

問題

A ManifestNotFoundException can be thrown in the logs. when an Application Link is attempting to be established in one of our applications and is failing or the link does not automatically identify the target application and steps must be entered manually.

診断

• An Application Link is configured to go through a proxy and the Application Link is not working.
• An Application Link is attempting to be established in one of our applications and is failing.
• When attempting to create an Application Link, it will not automatically identify the target application and steps must be entered manually.

atlassian-jira.log に次のメッセージが表示される。

2013-01-08 07:11:24,502 ajp-bio-8009-exec-22 ERROR thetusadmin 431x5138x1 fdkc4n 10.1.11.121 /rest/applinks/1.0/applicationlinkForm/manifest.json [core.rest.ui.CreateApplicationLinkUIResource] ManifestNotFoundException thrown while retrieving manifest
com.atlassian.applinks.spi.manifest.ManifestNotFoundException
	at com.atlassian.applinks.core.manifest.AppLinksManifestDownloader.download1(AppLinksManifestDownloader.java:181)
	at com.atlassian.applinks.core.manifest.AppLinksManifestDownloader.access$000(AppLinksManifestDownloader.java:41)
	at com.atlassian.applinks.core.manifest.AppLinksManifestDownloader$1$1.<init>(AppLinksManifestDownloader.java:83)
	at com.atlassian.applinks.core.manifest.AppLinksManifestDownloader$1.apply(AppLinksManifestDownloader.java:76)
	at com.atlassian.applinks.core.manifest.AppLinksManifestDownloader$1.apply(AppLinksManifestDownloader.java:73)
	at com.google.common.collect.ComputingConcurrentHashMap$ComputingValueReference.compute(ComputingConcurrentHashMap.java:355)

原因

When an Application Link is attempted to be created in an Atlassian application, it will attempt to connect to the target application's manifest. This manifest contains some important information such as the id, name, type, version, application link version and authentication types of the target application. If that information cannot be retrieved the application link will not be successfully created.

When attempting to establish application links, the following HTTP requests are made:

1. The source application will query its own applicationlinkForm, for example 

   http://jira.atlassian.com/rest/applinks/2.0/applicationlinkForm/manifest.json?url=http%3A%2F%2Fconfluence.atlassian.com%2F&_=1407984137588.

2. The source then establishes a HTTP connection to the manifest of the target application - in this example https://confluence.atlassian.com/rest/applinks/1.0/manifest.json.

   This is typically where the ManifestNotFoundException is thrown as JIRA cannot connect to Confluence due to network-layer problems.

3. And the source will then query its own manifest, for example, 

   http://JIRA_HOSTNAME/rest/applinks/2.0/manifest.json

If any of those network routings fail, the entire application link process can fail. If anything gets in the way of that network request and/or the request is not routed correctly, or the manifest cannot be downloaded, the AppLink will throw the ManifestNotFoundException as per the example above. The most common failures are:

• Proxies - both outbound and reverse - incorrectly routing traffic.
• DNS configurations - for example, something that forces network traffic to route through an authentication protocol such as Kerberos or NTLM.

There is also a known problem raised as an improvement request that obscures certain HTTP responses (those under 300 and over 400) that cause the AppLink to fail as tracked in  Unable to locate Jira server for this macro. It may be due to Application Link configuration. .

トラブルシューティング

• If using an outbound proxy (as per Configure an outbound proxy for use in Jira server) ensure that the target is defined in the http.nonProxyHosts.
• Disable any proxies between the target and source server, for example revert the changes in Configure an outbound proxy for use in Jira server and/or Integrating JIRA with Apache using SSL. This will also need to be done on the target applications.

• After updating the Base URLs of the target and the source to the IP:port, attempt to establish the application links using the IP:port number of the source and target instances in an attempt to bypass the proxy configurations.

  If the server.xml has been configured to use proxyName, proxyPort and scheme settings as per our recommended proxy docs this will not be possible, as it will redirect back to the proxy. For Bitbucket Server 5.0+ the equivalent properties are proxy-name, proxy-port, and scheme which are configured in bitbucket.properties.

• Verify the connection can be established from the target to the source server on the command-line using curl (installed in *nix by default) as per the below example. Replace potatobake with the hostname of the target. 

   curl -H "Accept: application/json" http://potatobake:8090/rest/applinks/1.0/manifest -v

  This will return something such as the below:

  * About to connect() to potatobake port 8090
  *   Trying 10.65.157.92... connected
  * Connected to potatobake (10.65.157.92) port 8090
  > GET /rest/applinks/1.0/manifest HTTP/1.1
  > User-Agent: curl/7.15.5 (x86_64-redhat-linux-gnu) libcurl/7.15.5 OpenSSL/0.9.8b zlib/1.2.3 libidn/0.6.5
  > Host: potatobake:8090
  > Accept: application/json
  >
  < HTTP/1.1 401 Unauthorized
  < Set-Cookie: FESESSIONID=1cf1ueey5icc41u9g62sb3blkd;Path=/;HttpOnly
  < WWW-Authenticate: Negotiate
  < WWW-Authenticate: Ntlm
  < WWW-Authenticate: Basic realm="OHYEAH.EXAMPLE.COM"
  < Content-Type: text/html;charset=ISO-8859-1
  < Cache-Control: must-revalidate,no-cache,no-store
  < Content-Length: 1397
  < Server: Jetty(8.1.10.v20130312)
  <html>
  <head>
  <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"/>
  <title>Error 401 Unauthorized</title>
  </head>
  <body><h2>HTTP ERROR 401</h2>
  <p>Problem accessing /rest/applinks/1.0/manifest. Reason:
  <pre>    Unauthorized</pre></p><hr /><i><small>Powered by Jetty://</small></i><br/>
  	...
  * Connection #0 to host potatobake left intact
  * Closing connection #0

  In this example, we can see an HTTP 401 is being returned when attempting to connect to a Fisheye server, which is caused by NTLM. This is causing the application link to fail as it cannot connect to the server successfully. This needs to be resolved by the administrators who configured NTLM.

ソリューション

Identify the problem with the network layer and correct it, as per the above troubleshooting steps.