This library is deprecated now. Please use bootstrap-play
This library implements basic functionality required by the platform frontend/microservices.
In your SBT build add:
resolvers += Resolver.bintrayRepo("hmrc", "releases")
libraryDependencies += "uk.gov.hmrc" %% "bootstrap-play-26" % "x.x.x"
In your application.conf file, add:
# An ApplicationLoader that uses Guice to bootstrap the application.
play.application.loader = "uk.gov.hmrc.play.bootstrap.ApplicationLoader"
# Primary entry point for all HTTP requests on Play applications
play.http.requestHandler = "uk.gov.hmrc.play.bootstrap.http.RequestHandler"
# Provides an implementation of AuditConnector. Use `uk.gov.hmrc.play.bootstrap.AuditModule` or create your own.
# An audit connector must be provided.
play.modules.enabled += "uk.gov.hmrc.play.bootstrap.AuditModule"
# Provides an implementation of MetricsFilter. Use `uk.gov.hmrc.play.bootstrap.graphite.GraphiteMetricsModule` or create your own.
# A metric filter must be provided
play.modules.enabled += "uk.gov.hmrc.play.bootstrap.graphite.GraphiteMetricsModule"
# Provides an implementation and configures all filters required by a Platform frontend microservice.
play.modules.enabled += "uk.gov.hmrc.play.bootstrap.FrontendModule"
play.http.filters = "uk.gov.hmrc.play.bootstrap.filters.FrontendFilters"
And in your SBT build add:
libraryDependencies += "uk.gov.hmrc" %% "play-ui" % "x.x.x"
libraryDependencies += "uk.gov.hmrc" %% "govuk-template" % "x.x.x"
In your application.conf file, add:
# An ApplicationLoader that uses Guice to bootstrap the application.
play.application.loader = "uk.gov.hmrc.play.bootstrap.ApplicationLoader"
# Primary entry point for all HTTP requests on Play applications
play.http.requestHandler = "uk.gov.hmrc.play.bootstrap.http.RequestHandler"
# Provides an implementation of AuditConnector. Use `uk.gov.hmrc.play.bootstrap.AuditModule` or create your own.
# An audit connector must be provided.
play.modules.enabled += "uk.gov.hmrc.play.bootstrap.AuditModule"
# Provides an implementation of MetricsFilter. Use `uk.gov.hmrc.play.bootstrap.graphite.GraphiteMetricsModule` or create your own.
# A metric filter must be provided
play.modules.enabled += "uk.gov.hmrc.play.bootstrap.graphite.GraphiteMetricsModule"
# Provides an implementation and configures all filters required by a Platform frontend microservice.
play.modules.enabled += "uk.gov.hmrc.play.bootstrap.MicroserviceModule"
play.http.filters = "uk.gov.hmrc.play.bootstrap.filters.MicroserviceFilters"
A default http client with pre-configured auditing hook can be injected into any connector. The http client uses http-verbs For more http-verbs examples see https://github.com/hmrc/http-verbs-example
Make sure you have the following modules in your application.conf file:
play.modules.enabled += "uk.gov.hmrc.play.bootstrap.AuditModule"
play.modules.enabled += "uk.gov.hmrc.play.bootstrap.HttpClientModule"
import uk.gov.hmrc.play.bootstrap.http.HttpClient
import javax.inject.Inject
class SomeConnector @Inject() (client: HttpClient) {
client.GET[Option[MyCaseClass]]("http://localhost/my-api")
}
The library supports user authorisation on microservices
Make sure you have the following modules in your application.conf file:
play.modules.enabled += "uk.gov.hmrc.play.bootstrap.AuditModule"
play.modules.enabled += "uk.gov.hmrc.play.bootstrap.HttpClientModule"
play.modules.enabled += "uk.gov.hmrc.play.bootstrap.AuthModule"
Your controller will look like this:
class MyController @Inject() (val authConnector: AuthConnector) extends BaseController with AuthorisedFunctions {
def getSomething(): Action[AnyContent] = Action.async { implicit request โ
authorised() {
// your protected logic
}
}
}
By default the logging MDC will be passed between threads by a custom ExecutorService
.
While this works in both test and production configurations it does not work in Dev
mode using the AkkaHttpServer
in Play 2.6.
If you would like the same functionality in Dev
mode, you must use the older
NettyHttpServer
.
- Enable the
PlayNettyServer
plugin in yourbuild.sbt
.enablePlugins(PlayNettyServer)
- Set the
NettyServerProvider
in thedevSettings
of yourbuild.sbt
PlayKeys.devSettings += "play.server.provider" -> "play.core.server.NettyServerProvider"
- Make sure you still use the
AkkaHttpServer
inProd
mode by specifying it inapplication.conf
play.server.provider = play.core.server.AkkaHttpServerProvider
Added Identity Verification (IV) CL250 support via auth-client 5.6, see May 2021 Tech Blog Post on this.
Http-verbs has been bumped to major version 13.0.0. See http-verbs for details.
auditing.auditExtraHeaders
as been renamed to auditing.auditSentHeaders
Invalid config key | Should now be |
---|---|
auditing.auditExtraHeaders | auditing.auditSentHeaders |
Http-verbs has been bumped to major version 12.0.0. See http-verbs for details.
The following configuration has been renamed, the previous keys are invalid and will need to be updated.
Invalid config key | Should now be |
---|---|
httpHeadersWhitelist | bootstrap.http.headersAllowlist |
csrfexceptions.whitelist | bootstrap.csrfexceptions.allowlist |
As of version 1.15.0, bootstrap-play-26
stops pulling in hmrc/time library transitively anymore.
If you require hmrc/time
, you will have to add an explicit dependency yourself.
This code is open source software licensed under the Apache 2.0 License.