ContentProtectionService

All Implemented Interfaces:

org.readium.r2.shared.publication.Publication.Service , org.readium.r2.shared.util.Closeable
```
public interface ContentProtectionService
 implements Publication.Service
                    
```
Provides information about a publication's content protection and manages user rights.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public interface`	`ContentProtectionService.UserRights`	Manages consumption of user rights and permissions.

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`Resource`	`get(Link link)`	A service can return a Resource to: respond to a request to its web API declared in links, serve additional resources on behalf of the publication, replace a publication resource by its own version. Called by Publication.get for each request.
`abstract Boolean`	`isRestricted()`	Whether the Publication has a restricted access to its resources, and can't be rendered in a Navigator.
`abstract UserException`	`getError()`	The error raised when trying to unlock the Publication, if any.
`abstract String`	`getCredentials()`	Credentials used to unlock this Publication.
`abstract ContentProtectionService.UserRights`	`getRights()`	Manages consumption of user rights and permissions.
`ContentProtection.Scheme`	`getScheme()`
`LocalizedString`	`getName()`
`List<Link>`	`getLinks()`

Methods inherited from class org.readium.r2.shared.publication.Publication.Service
close
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - get
```
 Resource get(Link link)
```
    A service can return a Resource to:
    respond to a request to its web API declared in links,
    serve additional resources on behalf of the publication,
    replace a publication resource by its own version.
    Called by Publication.get for each request.
    Warning: If you need to request one of the publication resources to answer the request, use the Fetcher provided by the Publication.Service.Context instead of Publication.get, otherwise it will trigger an infinite loop.
  - isRestricted
```
 abstract Boolean isRestricted()
```
    Whether the Publication has a restricted access to its resources, and can't be rendered in a Navigator.
  - getError
```
 abstract UserException getError()
```
    The error raised when trying to unlock the Publication, if any.
  - getCredentials
```
 abstract String getCredentials()
```
    Credentials used to unlock this Publication.
  - getRights
```
 abstract ContentProtectionService.UserRights getRights()
```
    Manages consumption of user rights and permissions.
  - getScheme
```
 ContentProtection.Scheme getScheme()
```
  - getName
```
 LocalizedString getName()
```
  - getLinks
```
 List<Link> getLinks()
```