Package org.exoplatform.agenda.util

Class CalendarFeedFetcher

java.lang.Object

org.exoplatform.agenda.util.CalendarFeedFetcher

@Component
public class CalendarFeedFetcher
extends Object

Reads a calendar link over HTTP (EXO-90278), within bounds.

Addresses are the CalendarAddressGuard's: it is the resolver of the connection manager, so the address of every connection is judged when the connection is opened; the guard also checks each URL's shape before it is requested, and redirects are followed here, one hop at a time, each target checked again. Bounds: a connect timeout, a read timeout, a deadline over the whole read — redirects included — enforced by cancelling the request, a body limit counted on the decoded bytes (a compressed body cannot inflate past it), and a redirect count. Nothing of the platform's goes out: no cookie store, no credentials, no proxy, no retry; the only headers sent are the ones a conditional read needs. Nothing of the URL goes into a log: it may embed a secret.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	CalendarFeedFetcher.FeedResponse	What a read of a link answered.

Field Summary

Fields

Modifier and Type	Field	Description
static final Duration	DEFAULT_CONNECT	Longest wait for a connection.
static final long	DEFAULT_MAX_BYTES	Largest body read, in bytes.
static final int	DEFAULT_MAX_REDIRECTS	Most redirects followed.
static final String	DEFAULT_PORTS	The ports a link may reach unless the deployment says otherwise.
static final Duration	DEFAULT_READ	Longest wait between two reads.
static final Duration	DEFAULT_TOTAL	Longest read of a link, redirects included.

Constructor Summary

Constructors

Constructor	Description
CalendarFeedFetcher(boolean allowInternalAddresses, String allowedPorts)	The fetcher of a deployment.

Method Summary

Modifier and Type	Method	Description
void	close()	Stops the deadline thread and closes the connections.
CalendarFeedFetcher.FeedResponse	fetch(URI uri, String etag, String lastModified)	Reads a link, conditionally when validators are given.
CalendarAddressGuard	getGuard()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT_MAX_BYTES

public static final long DEFAULT_MAX_BYTES

Largest body read, in bytes.

See Also:

• Constant Field Values

DEFAULT_CONNECT

public static final Duration DEFAULT_CONNECT

Longest wait for a connection.

DEFAULT_READ

public static final Duration DEFAULT_READ

Longest wait between two reads.

DEFAULT_TOTAL

public static final Duration DEFAULT_TOTAL

Longest read of a link, redirects included.

DEFAULT_MAX_REDIRECTS

public static final int DEFAULT_MAX_REDIRECTS

Most redirects followed.

See Also:

• Constant Field Values

DEFAULT_PORTS

public static final String DEFAULT_PORTS

The ports a link may reach unless the deployment says otherwise.

See Also:

• Constant Field Values

Constructor Details

CalendarFeedFetcher

@Autowired
public CalendarFeedFetcher(@Value("${exo.agenda.calendarSubscription.allowInternalAddresses:false}")
 boolean allowInternalAddresses,
 @Value("${exo.agenda.calendarSubscription.allowedPorts:80,443,8080,8443}")
 String allowedPorts)

The fetcher of a deployment.

Parameters:

allowInternalAddresses - whether internal addresses may be read, false by default: the deployment's opt-out, as caldav-integration's exo.agenda.caldav.server.allowPrivateAddresses

allowedPorts - comma-separated ports a link may reach

Method Details

getGuard

public CalendarAddressGuard getGuard()

Returns:

the address guard, whose URL rules the service applies before a read

fetch

public CalendarFeedFetcher.FeedResponse fetch(URI uri,
 String etag,
 String lastModified)
                                       throws CalendarFeedException

Reads a link, conditionally when validators are given.

Parameters:

uri - the URL, already normalized by the guard

etag - the entity tag of the previous read, or null

lastModified - the Last-Modified header of the previous read, or null

Returns:

what the server answered

Throws:

CalendarFeedException - with the reason nothing usable was read

close

@PreDestroy
public void close()

Stops the deadline thread and closes the connections.